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.addListener(listener);

Method Summary

Modifier and Type	Method	Description
`EurekaUpdatingListenerBuilder`	`addHttpHeader(CharSequence name, Object value)`	Adds the specified HTTP header.
`EurekaUpdatingListenerBuilder`	`addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)`	Adds the specified HTTP headers.
`EurekaUpdatingListenerBuilder`	`appGroupName(String appGroupName)`	Sets the group name of the application.
`EurekaUpdatingListenerBuilder`	`appName(String appName)`	Sets the name of the application.
`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`	`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`	`leaseDurationSeconds(int leaseDurationSeconds)`	Sets the lease duration in seconds.
`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 `ClientOptionValue`s.
`EurekaUpdatingListenerBuilder`	`options(Iterable<ClientOptionValue<?>> options)`	Adds the specified `ClientOptionValue`s.
`EurekaUpdatingListenerBuilder`	`port(int port)`	Sets the port used for `SessionProtocol.HTTP`.
`EurekaUpdatingListenerBuilder`	`renewalIntervalSeconds(int renewalIntervalSeconds)`	Sets the interval between renewal in seconds.
`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)`	Adds the specified RPC-level `decorator`.
`EurekaUpdatingListenerBuilder`	`rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)`	Adds the specified RPC-level `decorator`.
`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`	`setHttpHeader(CharSequence name, Object value)`	Sets the specified HTTP header.
`EurekaUpdatingListenerBuilder`	`setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)`	Sets the specified HTTP headers.
`EurekaUpdatingListenerBuilder`	`statusPageUrl(String statusPageUrl)`	Sets the status page URL.
`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

Methods inherited from class java.lang.Object

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

Method Details
- renewalIntervalSeconds
  
  public EurekaUpdatingListenerBuilder renewalIntervalSeconds(int renewalIntervalSeconds)
  
  Sets the interval between renewal in seconds. 30 is used by default and it's not recommended to modify this value. See renew.
- leaseDurationSeconds
  
  public EurekaUpdatingListenerBuilder leaseDurationSeconds(int leaseDurationSeconds)
  
  Sets the lease duration in seconds. 90 is used by default and it's not recommended to modify this value. 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
- 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: AbstractClientOptionsBuilder
  
  Adds the specified RPC-level decorator.
  
  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: AbstractClientOptionsBuilder
  
  Adds the specified RPC-level decorator.
  
  Overrides:
  
  rpcDecorator in class AbstractWebClientBuilder
  
  Parameters:
  
  decorator - the DecoratingRpcClientFunction that intercepts an invocation
- addHttpHeader
  
  public EurekaUpdatingListenerBuilder addHttpHeader(CharSequence name, Object value)
  
  Description copied from class: AbstractClientOptionsBuilder
  
  Adds the specified HTTP header.
  
  Overrides:
  
  addHttpHeader in class AbstractClientOptionsBuilder
- addHttpHeaders
  
  public EurekaUpdatingListenerBuilder addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)
  
  Description copied from class: AbstractClientOptionsBuilder
  
  Adds the specified HTTP headers.
  
  Overrides:
  
  addHttpHeaders in class AbstractClientOptionsBuilder
- setHttpHeader
  
  public EurekaUpdatingListenerBuilder setHttpHeader(CharSequence name, Object value)
  
  Description copied from class: AbstractClientOptionsBuilder
  
  Sets the specified HTTP header.
  
  Overrides:
  
  setHttpHeader in class AbstractClientOptionsBuilder
- setHttpHeaders
  
  public EurekaUpdatingListenerBuilder setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)
  
  Description copied from class: AbstractClientOptionsBuilder
  
  Sets the specified HTTP headers.
  
  Overrides:
  
  setHttpHeaders 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

Class EurekaUpdatingListenerBuilder

Examples

Method Summary

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

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

Methods inherited from class java.lang.Object

Method Details