Package com.linecorp.centraldogma.client.armeria.xds

Class XdsCentralDogmaBuilder

java.lang.Object

com.linecorp.centraldogma.client.AbstractCentralDogmaBuilder<XdsCentralDogmaBuilder>

com.linecorp.centraldogma.client.armeria.xds.XdsCentralDogmaBuilder

@UnstableApi
public final class XdsCentralDogmaBuilder
extends AbstractCentralDogmaBuilder<XdsCentralDogmaBuilder>

Builds a CentralDogma client based on an Armeria HTTP client. This client differs from ArmeriaCentralDogma in that making requests is done in two phases.

1. An xDS request is made to xDS servers to fetch a Listener resource which represents how to connect to CentralDogma servers.
2. Actual CentralDogma client requests are made based on the watched Listener resource.

Because connection to the actual CentralDogma is determined by the watched Listener, AbstractCentralDogmaBuilder.hosts() and AbstractCentralDogmaBuilder.isUseTls() apply to connecting to the bootstrap only. However, because Armeria's xDS implementation isn't complete, the following parameters are applied to both xDS and Central Dogma requests.

• AbstractCentralDogmaBuilder.accessToken(String)
• clientConfigurator(ArmeriaClientConfigurator)
• clientFactory(ClientFactory)

Note that this module is considered experimental and subject to behavioral change.

Constructor Summary

Constructors

Constructor	Description
XdsCentralDogmaBuilder()

Method Summary

Modifier and Type	Method	Description
XdsCentralDogmaBuilder	blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor)	Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations.
CentralDogma	build()	Returns a newly-created CentralDogma instance.
XdsCentralDogmaBuilder	clientConfigurator(ArmeriaClientConfigurator clientConfigurator)	Sets the ArmeriaClientConfigurator that will configure an underlying Armeria client which performs the actual socket I/O.
XdsCentralDogmaBuilder	clientFactory(ClientFactory clientFactory)	Sets the ClientFactory that will create an underlying Armeria client which performs the actual socket I/O.
XdsCentralDogmaBuilder	listenerName(String listenerName)	Sets the name of the Listener that should be requested to the xDS bootstrap servers.
XdsCentralDogmaBuilder	localClusterName(String localClusterName)	Sets the name of the local cluster name which this client will be located in.
XdsCentralDogmaBuilder	serviceZone(String serviceZone)	Sets the locality of where the CentralDogma client will be running.

Methods inherited from class com.linecorp.centraldogma.client.AbstractCentralDogmaBuilder

accessToken, accessToken, host, host, hosts, isUseTls, maxNumRetriesOnReplicationLag, maxNumRetriesOnReplicationLag, profile, profile, profile, profile, profileResources, profileResources, retryIntervalOnReplicationLag, retryIntervalOnReplicationLagMillis, retryIntervalOnReplicationLagMillis, selectedProfile, self, uri, useTls, useTls

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XdsCentralDogmaBuilder

public XdsCentralDogmaBuilder()

Method Details

listenerName

public XdsCentralDogmaBuilder listenerName(String listenerName)

Sets the name of the Listener that should be requested to the xDS bootstrap servers. The default is "centraldogma-listener".

serviceZone

@UnstableApi
public XdsCentralDogmaBuilder serviceZone(String serviceZone)

Sets the locality of where the CentralDogma client will be running. This may be used in applying zone aware routing and is analogous to service-zone. This value will be set to Node.getLocality() in the Bootstrap.

localClusterName

@UnstableApi
public XdsCentralDogmaBuilder localClusterName(String localClusterName)

Sets the name of the local cluster name which this client will be located in. This may be used in applying zone aware routing and is analogous to service-cluster. This value will be set to ClusterManager.getLocalClusterName() in the Bootstrap.

blockingTaskExecutor

public XdsCentralDogmaBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor)

Sets the ScheduledExecutorService dedicated to the execution of blocking tasks or invocations. If not set, the common pool is used. The ScheduledExecutorService which will be used for scheduling the tasks related with automatic retries and invoking the callbacks for watched changes.

clientConfigurator

public XdsCentralDogmaBuilder clientConfigurator(ArmeriaClientConfigurator clientConfigurator)

Sets the ArmeriaClientConfigurator that will configure an underlying Armeria client which performs the actual socket I/O.

Note that this doesn't affect the client making requests to the bootstrap servers.

clientFactory

public XdsCentralDogmaBuilder clientFactory(ClientFactory clientFactory)

Sets the ClientFactory that will create an underlying Armeria client which performs the actual socket I/O.

Note that this doesn't affect the client making requests to the bootstrap servers.

build

public CentralDogma build()

Returns a newly-created CentralDogma instance.