Package com.linecorp.armeria.server.eureka

Class EurekaUpdatingListenerBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractClientOptionsBuilder

com.linecorp.armeria.client.AbstractWebClientBuilder

com.linecorp.armeria.server.eureka.EurekaUpdatingListenerBuilder

public final class EurekaUpdatingListenerBuilder
extends AbstractWebClientBuilder

Builds a EurekaUpdatingListener, which registers the server to Eureka.

Examples

 EurekaUpdatingListener listener =
         EurekaUpdatingListener.builder("eureka.com:8001/eureka/v2")
                               .instanceId("i-00000000")
                               .setHostname("armeria.service.1")
                               .ipAddr("192.168.10.10")
                               .vipAddress("armeria.service.com:8080");
                               .build();
 ServerBuilder sb = Server.builder();
 sb.serverListener(listener);
 

Method Summary

Modifier and Type	Method	Description
EurekaUpdatingListenerBuilder	addHeader(CharSequence name, Object value)	Adds the default HTTP header for an HttpRequest that will be sent by this Client.
EurekaUpdatingListenerBuilder	addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Adds the default HTTP headers for an HttpRequest that will be sent by this Client.
EurekaUpdatingListenerBuilder	appGroupName(String appGroupName)	Sets the group name of the application.
EurekaUpdatingListenerBuilder	appName(String appName)	Sets the name of the application.
EurekaUpdatingListenerBuilder	auth(AuthToken token)	Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.
EurekaUpdatingListenerBuilder	auth(BasicToken token)	Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.
EurekaUpdatingListenerBuilder	auth(OAuth1aToken token)	Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.
EurekaUpdatingListenerBuilder	auth(OAuth2Token token)	Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.
EurekaUpdatingListener	build()	Returns a newly-created EurekaUpdatingListener based on the properties of this builder.
EurekaUpdatingListenerBuilder	clearDecorators()	Clears all HTTP-level and RPC-level decorators set so far.
EurekaUpdatingListenerBuilder	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.
EurekaUpdatingListenerBuilder	dataCenterMetadata(Map<String,String> dataCenterMetadata)	Sets the metadata of the data center.
EurekaUpdatingListenerBuilder	dataCenterName(String dataCenterName)	Sets the name of the data center.
EurekaUpdatingListenerBuilder	decorator(DecoratingHttpClientFunction decorator)	Adds the specified HTTP-level decorator.
EurekaUpdatingListenerBuilder	decorator(Function<? super HttpClient,? extends HttpClient> decorator)	Adds the specified HTTP-level decorator.
EurekaUpdatingListenerBuilder	endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)	Sets a Function that remaps an Endpoint into an EndpointGroup.
EurekaUpdatingListenerBuilder	factory(ClientFactory factory)	Sets the ClientFactory used for creating a client.
EurekaUpdatingListenerBuilder	healthCheckUrl(String healthCheckUrl)	Sets the health check URL.
EurekaUpdatingListenerBuilder	homePageUrl(String homePageUrl)	Sets the home page URL.
EurekaUpdatingListenerBuilder	hostname(String hostname)	Sets the hostname.
EurekaUpdatingListenerBuilder	instanceId(String instanceId)	Sets the ID of this instance.
EurekaUpdatingListenerBuilder	ipAddr(String ipAddr)	Sets the IP address.
EurekaUpdatingListenerBuilder	leaseDuration(Duration leaseDuration)	Sets the lease duration.
EurekaUpdatingListenerBuilder	leaseDurationMillis(long leaseDurationMillis)	Sets the lease duration in milliseconds.
EurekaUpdatingListenerBuilder	leaseDurationSeconds(int leaseDurationSeconds)	Deprecated. Use leaseDurationMillis(long).
EurekaUpdatingListenerBuilder	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
EurekaUpdatingListenerBuilder	metadata(Map<String,String> metadata)	Sets the metadata.
<T> EurekaUpdatingListenerBuilder	option(ClientOption<T> option, T value)	Adds the specified ClientOption and its value.
<T> EurekaUpdatingListenerBuilder	option(ClientOptionValue<T> optionValue)	Adds the specified ClientOptionValue.
EurekaUpdatingListenerBuilder	options(ClientOptions options)	Adds the specified ClientOptions.
EurekaUpdatingListenerBuilder	options(ClientOptionValue<?>... options)	Adds the specified ClientOptionValues.
EurekaUpdatingListenerBuilder	options(Iterable<ClientOptionValue<?>> options)	Adds the specified ClientOptionValues.
EurekaUpdatingListenerBuilder	port(int port)	Sets the port used for SessionProtocol.HTTP.
EurekaUpdatingListenerBuilder	renewalInterval(Duration renewalInterval)	Sets the interval between renewal.
EurekaUpdatingListenerBuilder	renewalIntervalMillis(long renewalIntervalMillis)	Sets the interval between renewal in milliseconds.
EurekaUpdatingListenerBuilder	renewalIntervalSeconds(int renewalIntervalSeconds)	Deprecated. Use renewalIntervalMillis(long).
EurekaUpdatingListenerBuilder	requestIdGenerator(Supplier<RequestId> requestIdGenerator)	Sets the Supplier that generates a RequestId.
EurekaUpdatingListenerBuilder	responseTimeout(Duration responseTimeout)	Sets the timeout of a response.
EurekaUpdatingListenerBuilder	responseTimeoutMillis(long responseTimeoutMillis)	Sets the timeout of a response in milliseconds.
EurekaUpdatingListenerBuilder	rpcDecorator(DecoratingRpcClientFunction decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
EurekaUpdatingListenerBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)	Raises an UnsupportedOperationException because this builder doesn't support RPC-level but only HTTP-level decorators.
EurekaUpdatingListenerBuilder	secureHealthCheckUrl(String secureHealthCheckUrl)	Sets the secure health check URL.
EurekaUpdatingListenerBuilder	securePort(int securePort)	Sets the port used for SessionProtocol.HTTPS.
EurekaUpdatingListenerBuilder	secureVipAddress(String secureVipAddress)	Sets the secure VIP address.
EurekaUpdatingListenerBuilder	setHeader(CharSequence name, Object value)	Sets the default HTTP header for an HttpRequest that will be sent by this Client.
EurekaUpdatingListenerBuilder	setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)	Sets the default HTTP headers for an HttpRequest that will be sent by this Client.
EurekaUpdatingListenerBuilder	statusPageUrl(String statusPageUrl)	Sets the status page URL.
EurekaUpdatingListenerBuilder	successFunction(SuccessFunction successFunction)	Sets a SuccessFunction that determines whether a request was handled successfully or not.
EurekaUpdatingListenerBuilder	vipAddress(String vipAddress)	Sets the VIP address.
EurekaUpdatingListenerBuilder	writeTimeout(Duration writeTimeout)	Sets the timeout of a socket write attempt.
EurekaUpdatingListenerBuilder	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, followRedirects, followRedirects

Methods inherited from class java.lang.Object

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

Method Details

renewalInterval

public EurekaUpdatingListenerBuilder renewalInterval(Duration renewalInterval)

Sets the interval between renewal. 30 seconds is used by default and it's not recommended to modify this value. Eureka protocol stores this value in seconds internally, and thus this method will convert the given interval into seconds, rounding up its sub-second part. See renew.

renewalIntervalSeconds

@Deprecated
public EurekaUpdatingListenerBuilder renewalIntervalSeconds(int renewalIntervalSeconds)

Deprecated.

Use renewalIntervalMillis(long).

Sets the interval between renewal in seconds. 30 is used by default and it's not recommended to modify this value. See renew.

renewalIntervalMillis

public EurekaUpdatingListenerBuilder renewalIntervalMillis(long renewalIntervalMillis)

Sets the interval between renewal in milliseconds. 30000 (30 seconds) is used by default and it's not recommended to modify this value. Eureka protocol stores this value in seconds internally, and thus this method will convert the given interval into seconds, rounding up its sub-second part. See renew.

leaseDuration

public EurekaUpdatingListenerBuilder leaseDuration(Duration leaseDuration)

Sets the lease duration. 90 seconds is used by default and it's not recommended to modify this value. Eureka protocol stores this value in seconds internally, and thus this method will convert the given duration into seconds, rounding up its sub-second part. See renew.

leaseDurationSeconds

@Deprecated
public EurekaUpdatingListenerBuilder leaseDurationSeconds(int leaseDurationSeconds)

Deprecated.

Use leaseDurationMillis(long).

Sets the lease duration in seconds. 90 is used by default and it's not recommended to modify this value. See renew.

leaseDurationMillis

public EurekaUpdatingListenerBuilder leaseDurationMillis(long leaseDurationMillis)

Sets the lease duration in milliseconds. 90000 (90 seconds) is used by default and it's not recommended to modify this value. Eureka protocol stores this value in seconds internally, and thus this method will convert the given duration into seconds, rounding up its sub-second part. See renew.

hostname

public EurekaUpdatingListenerBuilder hostname(String hostname)

Sets the hostname. Server.defaultHostname() is set if not specified.

instanceId

public EurekaUpdatingListenerBuilder instanceId(String instanceId)

Sets the ID of this instance. hostname(String) is set if not specified.

appName

public EurekaUpdatingListenerBuilder appName(String appName)

Sets the name of the application. hostname(String) is set if not specified.

appGroupName

public EurekaUpdatingListenerBuilder appGroupName(String appGroupName)

Sets the group name of the application.

ipAddr

public EurekaUpdatingListenerBuilder ipAddr(String ipAddr)

Sets the IP address. SystemInfo.defaultNonLoopbackIpV4Address() is set if not specified.

port

public EurekaUpdatingListenerBuilder port(int port)

Sets the port used for SessionProtocol.HTTP.

securePort

public EurekaUpdatingListenerBuilder securePort(int securePort)

Sets the port used for SessionProtocol.HTTPS.

vipAddress

public EurekaUpdatingListenerBuilder vipAddress(String vipAddress)

Sets the VIP address. hostname(String) is set if not specified.

secureVipAddress

public EurekaUpdatingListenerBuilder secureVipAddress(String secureVipAddress)

Sets the secure VIP address. hostname(String) is set if not specified.

homePageUrl

public EurekaUpdatingListenerBuilder homePageUrl(String homePageUrl)

Sets the home page URL.

statusPageUrl

public EurekaUpdatingListenerBuilder statusPageUrl(String statusPageUrl)

Sets the status page URL.

healthCheckUrl

public EurekaUpdatingListenerBuilder healthCheckUrl(String healthCheckUrl)

Sets the health check URL. If HealthCheckService is added to ServerBuilder and Server.activePort(SessionProtocol.HTTP) returns an active port, then this URL will be automatically create using the information of the HealthCheckService.

secureHealthCheckUrl

public EurekaUpdatingListenerBuilder secureHealthCheckUrl(String secureHealthCheckUrl)

Sets the secure health check URL. If HealthCheckService is added to ServerBuilder and Server.activePort(SessionProtocol.HTTPS) returns an active port, then this URL will be automatically create using the information of the HealthCheckService.

metadata

public EurekaUpdatingListenerBuilder metadata(Map<String,String> metadata)

Sets the metadata.

dataCenterName

public EurekaUpdatingListenerBuilder dataCenterName(String dataCenterName)

Sets the name of the data center.

dataCenterMetadata

public EurekaUpdatingListenerBuilder dataCenterMetadata(Map<String,String> dataCenterMetadata)

Sets the metadata of the data center.

build

public EurekaUpdatingListener build()

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

options

public EurekaUpdatingListenerBuilder options(ClientOptions options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptions.

Overrides:

options in class AbstractClientOptionsBuilder

options

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

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

options

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

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

option

public <T> EurekaUpdatingListenerBuilder 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> EurekaUpdatingListenerBuilder option(ClientOptionValue<T> optionValue)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValue.

Overrides:

option in class AbstractClientOptionsBuilder

factory

public EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Description copied from class: AbstractClientOptionsBuilder

Sets the Supplier that generates a RequestId.

Overrides:

requestIdGenerator in class AbstractClientOptionsBuilder

successFunction

public EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder clearDecorators()

Description copied from class: AbstractClientOptionsBuilder

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

Overrides:

clearDecorators in class AbstractClientOptionsBuilder

addHeader

public EurekaUpdatingListenerBuilder addHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Adds the default HTTP header for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in the HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

addHeader in class AbstractClientOptionsBuilder

addHeaders

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

Description copied from class: AbstractClientOptionsBuilder

Adds the default HTTP headers for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in the HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

addHeaders in class AbstractClientOptionsBuilder

setHeader

public EurekaUpdatingListenerBuilder setHeader(CharSequence name,
 Object value)

Description copied from class: AbstractClientOptionsBuilder

Sets the default HTTP header for an HttpRequest that will be sent by this Client.

Note that the default HTTP header could be overridden if the same HttpHeaderNames are defined in HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

setHeader in class AbstractClientOptionsBuilder

setHeaders

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

Description copied from class: AbstractClientOptionsBuilder

Sets the default HTTP headers for an HttpRequest that will be sent by this Client.

Note that the values of the default HTTP headers could be overridden if the same HttpHeaderNames are defined in HttpRequest.headers() or ClientRequestContext.additionalRequestHeaders().

Overrides:

setHeaders in class AbstractClientOptionsBuilder

auth

public EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder 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 EurekaUpdatingListenerBuilder auth(OAuth2Token token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public EurekaUpdatingListenerBuilder auth(AuthToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the AuthToken header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

contextCustomizer

public EurekaUpdatingListenerBuilder 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)