Package com.linecorp.armeria.client.eureka

Class EurekaEndpointGroupBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractClientOptionsBuilder

com.linecorp.armeria.client.AbstractWebClientBuilder

com.linecorp.armeria.client.eureka.EurekaEndpointGroupBuilder

All Implemented Interfaces:

DynamicEndpointGroupSetters

public final class EurekaEndpointGroupBuilder
extends AbstractWebClientBuilder
implements DynamicEndpointGroupSetters

Builds a EurekaEndpointGroup.

Method Summary

Modifier and Type	Method	Description
EurekaEndpointGroupBuilder	addHeader(CharSequence name, Object value)	Adds the specified HTTP header.
EurekaEndpointGroupBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Adds the specified HTTP headers.
EurekaEndpointGroupBuilder	allowEmptyEndpoints(boolean allowEmptyEndpoints)	Sets whether to allow an empty Endpoint list.
EurekaEndpointGroupBuilder	appName(String appName)	Sets the specified appName.
EurekaEndpointGroupBuilder	auth(AuthToken token)	Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.
EurekaEndpointGroupBuilder	auth(BasicToken token)	Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.
EurekaEndpointGroupBuilder	auth(OAuth1aToken token)	Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.
EurekaEndpointGroupBuilder	auth(OAuth2Token token)	Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.
EurekaEndpointGroup	build()	Returns a newly-created EurekaEndpointGroup based on the properties set so far.
EurekaEndpointGroupBuilder	clearDecorators()	Clears all HTTP-level and RPC-level decorators set so far.
EurekaEndpointGroupBuilder	contextCustomizer(Consumer<? super ClientRequestContext> contextCustomizer)	Adds the specified ClientRequestContext customizer function so that it customizes the context in the thread that initiated the client call.
EurekaEndpointGroupBuilder	decorator(DecoratingHttpClientFunction decorator)	Adds the specified HTTP-level decorator.
EurekaEndpointGroupBuilder	decorator(Function<? super HttpClient,? extends HttpClient> decorator)	Adds the specified HTTP-level decorator.
EurekaEndpointGroupBuilder	endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)	Sets a Function that remaps an Endpoint into an EndpointGroup.
EurekaEndpointGroupBuilder	factory(ClientFactory factory)	Sets the ClientFactory used for creating a client.
EurekaEndpointGroupBuilder	followRedirects()	Enables automatic redirection.
EurekaEndpointGroupBuilder	followRedirects(RedirectConfig redirectConfig)	Sets the RedirectConfig to enable automatic redirection.
EurekaEndpointGroupBuilder	instanceId(String instanceId)	Sets the specified instanceId.
EurekaEndpointGroupBuilder	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
<T> EurekaEndpointGroupBuilder	option(ClientOption<T> option, T value)	Adds the specified ClientOption and its value.
<T> EurekaEndpointGroupBuilder	option(ClientOptionValue<T> optionValue)	Adds the specified ClientOptionValue.
EurekaEndpointGroupBuilder	options(ClientOptions options)	Adds the specified ClientOptions.
EurekaEndpointGroupBuilder	options(ClientOptionValue<?>... options)	Adds the specified ClientOptionValues.
EurekaEndpointGroupBuilder	options(Iterable<ClientOptionValue<?>> options)	Adds the specified ClientOptionValues.
EurekaEndpointGroupBuilder	regions(Iterable<String> regions)	Sets the specified regions.
EurekaEndpointGroupBuilder	regions(String... regions)	Sets the specified regions.
EurekaEndpointGroupBuilder	registryFetchInterval(Duration registryFetchInterval)	Sets the interval between fetching registry requests.
EurekaEndpointGroupBuilder	registryFetchIntervalMillis(long registryFetchIntervalMillis)	Sets the interval between fetching registry requests in milliseconds.
EurekaEndpointGroupBuilder	registryFetchIntervalSeconds(long registryFetchIntervalSeconds)	Deprecated. Use registryFetchIntervalMillis(long).
EurekaEndpointGroupBuilder	requestIdGenerator(Supplier<RequestId> requestIdGenerator)	Sets the Supplier that generates a RequestId.
EurekaEndpointGroupBuilder	responseTimeout(Duration responseTimeout)	Sets the timeout of a response.
EurekaEndpointGroupBuilder	responseTimeoutMillis(long responseTimeoutMillis)	Sets the timeout of a response in milliseconds.
EurekaEndpointGroupBuilder	rpcDecorator(DecoratingRpcClientFunction decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
EurekaEndpointGroupBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
EurekaEndpointGroupBuilder	secureVipAddress(String secureVipAddress)	Sets the specified secureVipAddress.
EurekaEndpointGroupBuilder	selectionStrategy(EndpointSelectionStrategy selectionStrategy)	Sets the EndpointSelectionStrategy of the EurekaEndpointGroup.
EurekaEndpointGroupBuilder	selectionTimeout(Duration selectionTimeout)	Sets the timeout to wait until a successful Endpoint selection.
EurekaEndpointGroupBuilder	selectionTimeoutMillis(long selectionTimeoutMillis)	Sets the timeout to wait until a successful Endpoint selection.
EurekaEndpointGroupBuilder	setHeader(CharSequence name, Object value)	Sets the specified HTTP header.
EurekaEndpointGroupBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Sets the specified HTTP headers.
EurekaEndpointGroupBuilder	successFunction(SuccessFunction successFunction)	Sets a SuccessFunction that determines whether a request was handled successfully or not.
EurekaEndpointGroupBuilder	vipAddress(String vipAddress)	Sets the specified vipAddress.
EurekaEndpointGroupBuilder	writeTimeout(Duration writeTimeout)	Sets the timeout of a socket write attempt.
EurekaEndpointGroupBuilder	writeTimeoutMillis(long writeTimeoutMillis)	Sets the timeout of a socket write attempt in milliseconds.

Methods inherited from class com.linecorp.armeria.client.AbstractWebClientBuilder

buildWebClient, clientBuilderParams

Methods inherited from class com.linecorp.armeria.client.AbstractClientOptionsBuilder

buildOptions, buildOptions

Methods inherited from class java.lang.Object

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

Method Details

selectionStrategy

public EurekaEndpointGroupBuilder selectionStrategy(EndpointSelectionStrategy selectionStrategy)

Sets the EndpointSelectionStrategy of the EurekaEndpointGroup.

regions

public EurekaEndpointGroupBuilder regions(String... regions)

Sets the specified regions. EurekaEndpointGroup will retrieve the registry information which belongs to the regions.

regions

public EurekaEndpointGroupBuilder regions(Iterable<String> regions)

Sets the specified regions. EurekaEndpointGroup will retrieve the registry information which belongs to the regions.

appName

public EurekaEndpointGroupBuilder appName(String appName)

Sets the specified appName. EurekaEndpointGroup will retrieve the registry information whose application name is the specified appName.

Throws:

IllegalStateException - if vipAddress(String) or secureVipAddress(String) is called already

instanceId

public EurekaEndpointGroupBuilder instanceId(String instanceId)

Sets the specified instanceId. EurekaEndpointGroup will only retrieve the registry information whose instance ID is the specified instanceId.

Throws:

IllegalStateException - if vipAddress(String) or secureVipAddress(String) is called already

vipAddress

public EurekaEndpointGroupBuilder vipAddress(String vipAddress)

Sets the specified vipAddress. EurekaEndpointGroup will retrieve the registry information whose VIP address is the specified vipAddress.

Throws:

IllegalStateException - if appName(String), instanceId(String) or secureVipAddress(String) is called already

secureVipAddress

public EurekaEndpointGroupBuilder secureVipAddress(String secureVipAddress)

Sets the specified secureVipAddress. EurekaEndpointGroup will retrieve the registry information whose VIP address is the specified secureVipAddress.

Throws:

IllegalStateException - if appName(String), instanceId(String) or vipAddress(String) is called already

registryFetchInterval

public EurekaEndpointGroupBuilder registryFetchInterval(Duration registryFetchInterval)

Sets the interval between fetching registry requests. 30000L milliseconds is used by default and it's not recommended to modify this value. See fetch-registry.

registryFetchIntervalSeconds

@Deprecated
public EurekaEndpointGroupBuilder registryFetchIntervalSeconds(long registryFetchIntervalSeconds)

Deprecated.

Use registryFetchIntervalMillis(long).

Sets the interval between fetching registry requests in seconds. 30 is used by default and it's not recommended to modify this value. See fetch-registry.

registryFetchIntervalMillis

public EurekaEndpointGroupBuilder registryFetchIntervalMillis(long registryFetchIntervalMillis)

Sets the interval between fetching registry requests in milliseconds. 30000L is used by default and it's not recommended to modify this value. See fetch-registry.

build

public EurekaEndpointGroup build()

Returns a newly-created EurekaEndpointGroup based on the properties set so far. Note that if RetryingClient was not set using decorator(DecoratingHttpClientFunction), RetryingClient is applied automatically using RetryingClient.newDecorator(RetryRule.failsafe(), 3).

options

public EurekaEndpointGroupBuilder options(ClientOptions options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptions.

Overrides:

options in class AbstractClientOptionsBuilder

options

public EurekaEndpointGroupBuilder options(ClientOptionValue<?>... options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

options

public EurekaEndpointGroupBuilder options(Iterable<ClientOptionValue<?>> options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

option

public <T> EurekaEndpointGroupBuilder option(ClientOption<T> option,
 T value)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOption and its value.

Overrides:

option in class AbstractClientOptionsBuilder

option

public <T> EurekaEndpointGroupBuilder option(ClientOptionValue<T> optionValue)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValue.

Overrides:

option in class AbstractClientOptionsBuilder

factory

public EurekaEndpointGroupBuilder factory(ClientFactory factory)

Description copied from class: AbstractClientOptionsBuilder

Sets the ClientFactory used for creating a client. The default is ClientFactory.ofDefault().

Overrides:

factory in class AbstractClientOptionsBuilder

writeTimeout

public EurekaEndpointGroupBuilder writeTimeout(Duration writeTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt.

Overrides:

writeTimeout in class AbstractClientOptionsBuilder

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

writeTimeoutMillis

public EurekaEndpointGroupBuilder writeTimeoutMillis(long writeTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt in milliseconds.

Overrides:

writeTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

responseTimeout

public EurekaEndpointGroupBuilder responseTimeout(Duration responseTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response.

Overrides:

responseTimeout in class AbstractClientOptionsBuilder

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

responseTimeoutMillis

public EurekaEndpointGroupBuilder responseTimeoutMillis(long responseTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response in milliseconds.

Overrides:

responseTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

maxResponseLength

public EurekaEndpointGroupBuilder maxResponseLength(long maxResponseLength)

Description copied from class: AbstractClientOptionsBuilder

Sets the maximum allowed length of a server response in bytes.

Overrides:

maxResponseLength in class AbstractClientOptionsBuilder

Parameters:

maxResponseLength - the maximum length in bytes. 0 disables the limit.

requestIdGenerator

public EurekaEndpointGroupBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Description copied from class: AbstractClientOptionsBuilder

Sets the Supplier that generates a RequestId.

Overrides:

requestIdGenerator in class AbstractClientOptionsBuilder

successFunction

public EurekaEndpointGroupBuilder successFunction(SuccessFunction successFunction)

Description copied from class: AbstractClientOptionsBuilder

Sets a SuccessFunction that determines whether a request was handled successfully or not. If unspecified, SuccessFunction.ofDefault() is used.

Overrides:

successFunction in class AbstractClientOptionsBuilder

endpointRemapper

public EurekaEndpointGroupBuilder endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)

Description copied from class: AbstractClientOptionsBuilder

Sets a Function that remaps an Endpoint into an EndpointGroup. This ClientOption is useful when you need to override a single target host into a group of hosts to enable client-side load-balancing, e.g.

 MyService.Iface client =
     Clients.newClient("tbinary+http://example.com/api",
                       MyService.Iface.class);

 EndpointGroup myGroup = EndpointGroup.of(Endpoint.of("node-1.example.com")),
                                          Endpoint.of("node-2.example.com")));

 MyService.Iface derivedClient =
     Clients.newDerivedClient(client, options -> {
         return options.toBuilder()
                       .endpointRemapper(endpoint -> {
                           if (endpoint.host().equals("example.com")) {
                               return myGroup;
                           } else {
                               return endpoint;
                           }
                       })
                       .build();
     });

 // This request goes to 'node-1.example.com' or 'node-2.example.com'.
 derivedClient.call();
 

Note that the remapping does not occur recursively but only once.

Overrides:

endpointRemapper in class AbstractClientOptionsBuilder

See Also:

• ClientOptions.ENDPOINT_REMAPPER
• ClientOptions.endpointRemapper()

decorator

public EurekaEndpointGroupBuilder decorator(Function<? super HttpClient,? extends HttpClient> decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an HttpClient to another

decorator

public EurekaEndpointGroupBuilder decorator(DecoratingHttpClientFunction decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingHttpClientFunction that intercepts an invocation

rpcDecorator

public EurekaEndpointGroupBuilder rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)

Description copied from class: AbstractWebClientBuilder

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractWebClientBuilder

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

public EurekaEndpointGroupBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Description copied from class: AbstractWebClientBuilder

Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.

Overrides:

rpcDecorator in class AbstractWebClientBuilder

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation

clearDecorators

public EurekaEndpointGroupBuilder clearDecorators()

Description copied from class: AbstractClientOptionsBuilder

Clears all HTTP-level and RPC-level decorators set so far.

Overrides:

clearDecorators in class AbstractClientOptionsBuilder

addHeader

public EurekaEndpointGroupBuilder addHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP header.

Overrides:

addHeader in class AbstractClientOptionsBuilder

addHeaders

public EurekaEndpointGroupBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP headers.

Overrides:

addHeaders in class AbstractClientOptionsBuilder

setHeader

public EurekaEndpointGroupBuilder setHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Sets the specified HTTP header.

Overrides:

setHeader in class AbstractClientOptionsBuilder

setHeaders

public EurekaEndpointGroupBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)

Description copied from class: AbstractClientOptionsBuilder

Sets the specified HTTP headers.

Overrides:

setHeaders in class AbstractClientOptionsBuilder

auth

public EurekaEndpointGroupBuilder auth(BasicToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public EurekaEndpointGroupBuilder auth(OAuth1aToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public EurekaEndpointGroupBuilder auth(OAuth2Token token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public EurekaEndpointGroupBuilder auth(AuthToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

followRedirects

public EurekaEndpointGroupBuilder followRedirects()

Description copied from class: AbstractClientOptionsBuilder

Enables automatic redirection.

Overrides:

followRedirects in class AbstractClientOptionsBuilder

followRedirects

public EurekaEndpointGroupBuilder followRedirects(RedirectConfig redirectConfig)

Description copied from class: AbstractClientOptionsBuilder

Sets the RedirectConfig to enable automatic redirection.

Overrides:

followRedirects in class AbstractClientOptionsBuilder

contextCustomizer

public EurekaEndpointGroupBuilder contextCustomizer(Consumer<? super ClientRequestContext> contextCustomizer)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientRequestContext customizer function so that it customizes the context in the thread that initiated the client call. The given customizer function is evaluated before the customizer function specified by Clients.withContextCustomizer(Consumer).

 static final ThreadLocal<String> USER_ID = new ThreadLocal<>();
 static final AttributeKey<String> USER_ID_ATTR = AttributeKey.valueOf("USER_ID");
 ...
 MyClientStub client =
     Clients.builder(...)
            .contextCustomizer(ctx -> {
                // This customizer will be invoked from the thread that initiates a client call.
                ctx.setAttr(USER_ID_ATTR, USER_ID.get());
            })
            .build(MyClientStub.class);

 // Good:
 // The context data is set by the thread that initiates the client call.
 USER_ID.set("user1");
 try {
     client.executeSomething1(..);
     ...
     client.executeSomethingN(..);
 } finally {
     // Should clean up the thread local storage.
     USER_ID.remove();
 }

 // Bad:
 USER_ID.set("user1");
 executor.execute(() -> {
     // The variable in USER_ID won't be propagated to the context.
     // The variable is not valid at the moment client.executeSomething1() is called.
      client.executeSomething1(..);
 });
 

Note that certain properties of ClientRequestContext, such as:

• ClientRequestContext.endpoint()
• RequestContext.localAddress()
• RequestContext.remoteAddress()

may be null while the customizer function runs, because the target host of the Request is not determined yet.

Overrides:

contextCustomizer in class AbstractClientOptionsBuilder

See Also:

• Clients.withContextCustomizer(Consumer)

allowEmptyEndpoints

public EurekaEndpointGroupBuilder allowEmptyEndpoints(boolean allowEmptyEndpoints)

Description copied from interface: DynamicEndpointGroupSetters

Sets whether to allow an empty Endpoint list. If unspecified, an empty Endpoint list is allowed.

Specified by:

allowEmptyEndpoints in interface DynamicEndpointGroupSetters

selectionTimeout

public EurekaEndpointGroupBuilder selectionTimeout(Duration selectionTimeout)

Sets the timeout to wait until a successful Endpoint selection. Duration.ZERO disables the timeout. If unspecified, Flags.defaultResponseTimeoutMillis() is used by default.

Specified by:

selectionTimeout in interface DynamicEndpointGroupSetters

selectionTimeoutMillis

public EurekaEndpointGroupBuilder selectionTimeoutMillis(long selectionTimeoutMillis)

Sets the timeout to wait until a successful Endpoint selection. 0 disables the timeout. If unspecified, Flags.defaultResponseTimeoutMillis() is used by default.

Specified by:

selectionTimeoutMillis in interface DynamicEndpointGroupSetters