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 com.linecorp.armeria.client.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 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. Derived from hostname(String), appName(String) and port(int), 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.

    • homePageUrlPath

      public EurekaUpdatingListenerBuilder homePageUrlPath(String homePageUrlPath)
      Sets the home page URL path used to automatically create homePageUrl(String).

    • homePageUrl

      public EurekaUpdatingListenerBuilder homePageUrl(String homePageUrl)
      Sets the home page URL.

    • statusPageUrlPath

      public EurekaUpdatingListenerBuilder statusPageUrlPath(String statusPageUrlPath)
      Sets the status page URL path used to automatically create statusPageUrl(String).

    • statusPageUrl

      public EurekaUpdatingListenerBuilder statusPageUrl(String statusPageUrl)
      Sets the status page URL.

    • healthCheckUrlPath

      public EurekaUpdatingListenerBuilder healthCheckUrlPath(String healthCheckUrlPath)
      Sets the health check path used to automatically create healthCheckUrl(String) and secureHealthCheckUrl(String).

    • 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(com.linecorp.armeria.client.ClientOptions options)
      Overrides:
      options in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • options

      public EurekaUpdatingListenerBuilder options(com.linecorp.armeria.client.ClientOptionValue<?>... options)
      Overrides:
      options in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • options

      public EurekaUpdatingListenerBuilder options(Iterable<com.linecorp.armeria.client.ClientOptionValue<?>> options)
      Overrides:
      options in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • option

      public <T> EurekaUpdatingListenerBuilder option(com.linecorp.armeria.client.ClientOption<T> option, T value)
      Overrides:
      option in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • option

      public <T> EurekaUpdatingListenerBuilder option(com.linecorp.armeria.client.ClientOptionValue<T> optionValue)
      Overrides:
      option in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • factory

      public EurekaUpdatingListenerBuilder factory(com.linecorp.armeria.client.ClientFactory factory)
      Overrides:
      factory in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • writeTimeout

      public EurekaUpdatingListenerBuilder writeTimeout(Duration writeTimeout)
      Overrides:
      writeTimeout in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • writeTimeoutMillis

      public EurekaUpdatingListenerBuilder writeTimeoutMillis(long writeTimeoutMillis)
      Overrides:
      writeTimeoutMillis in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • responseTimeout

      public EurekaUpdatingListenerBuilder responseTimeout(Duration responseTimeout)
      Overrides:
      responseTimeout in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • responseTimeoutMillis

      public EurekaUpdatingListenerBuilder responseTimeoutMillis(long responseTimeoutMillis)
      Overrides:
      responseTimeoutMillis in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • maxResponseLength

      public EurekaUpdatingListenerBuilder maxResponseLength(long maxResponseLength)
      Overrides:
      maxResponseLength in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • requestAutoAbortDelay

      public EurekaUpdatingListenerBuilder requestAutoAbortDelay(Duration delay)
      Overrides:
      requestAutoAbortDelay in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • requestAutoAbortDelayMillis

      public EurekaUpdatingListenerBuilder requestAutoAbortDelayMillis(long delayMillis)
      Overrides:
      requestAutoAbortDelayMillis in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • requestIdGenerator

      public EurekaUpdatingListenerBuilder requestIdGenerator(Supplier<com.linecorp.armeria.common.RequestId> requestIdGenerator)
      Overrides:
      requestIdGenerator in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • successFunction

      public EurekaUpdatingListenerBuilder successFunction(com.linecorp.armeria.common.SuccessFunction successFunction)
      Overrides:
      successFunction in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • endpointRemapper

      public EurekaUpdatingListenerBuilder endpointRemapper(Function<? super com.linecorp.armeria.client.Endpoint,? extends com.linecorp.armeria.client.endpoint.EndpointGroup> endpointRemapper)
      Overrides:
      endpointRemapper in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • decorator

      public EurekaUpdatingListenerBuilder decorator(Function<? super com.linecorp.armeria.client.HttpClient,? extends com.linecorp.armeria.client.HttpClient> decorator)
      Overrides:
      decorator in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • decorator

      public EurekaUpdatingListenerBuilder decorator(com.linecorp.armeria.client.DecoratingHttpClientFunction decorator)
      Overrides:
      decorator in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • rpcDecorator

      public EurekaUpdatingListenerBuilder rpcDecorator(Function<? super com.linecorp.armeria.client.RpcClient,? extends com.linecorp.armeria.client.RpcClient> decorator)
      Overrides:
      rpcDecorator in class com.linecorp.armeria.client.AbstractWebClientBuilder

    • rpcDecorator

      public EurekaUpdatingListenerBuilder rpcDecorator(com.linecorp.armeria.client.DecoratingRpcClientFunction decorator)
      Overrides:
      rpcDecorator in class com.linecorp.armeria.client.AbstractWebClientBuilder

    • clearDecorators

      public EurekaUpdatingListenerBuilder clearDecorators()
      Overrides:
      clearDecorators in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • addHeader

      public EurekaUpdatingListenerBuilder addHeader(CharSequence name, Object value)
      Overrides:
      addHeader in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • addHeaders

      public EurekaUpdatingListenerBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
      Overrides:
      addHeaders in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • setHeader

      public EurekaUpdatingListenerBuilder setHeader(CharSequence name, Object value)
      Overrides:
      setHeader in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • setHeaders

      public EurekaUpdatingListenerBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
      Overrides:
      setHeaders in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • auth

      public EurekaUpdatingListenerBuilder auth(com.linecorp.armeria.common.auth.BasicToken token)
      Overrides:
      auth in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • auth

      public EurekaUpdatingListenerBuilder auth(com.linecorp.armeria.common.auth.OAuth1aToken token)
      Overrides:
      auth in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • auth

      public EurekaUpdatingListenerBuilder auth(com.linecorp.armeria.common.auth.OAuth2Token token)
      Overrides:
      auth in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • auth

      public EurekaUpdatingListenerBuilder auth(com.linecorp.armeria.common.auth.AuthToken token)
      Overrides:
      auth in class com.linecorp.armeria.client.AbstractClientOptionsBuilder

    • contextCustomizer

      public EurekaUpdatingListenerBuilder contextCustomizer(Consumer<? super com.linecorp.armeria.client.ClientRequestContext> contextCustomizer)
      Overrides:
      contextCustomizer in class com.linecorp.armeria.client.AbstractClientOptionsBuilder