Package com.linecorp.armeria.server.consul

Class ConsulUpdatingListenerBuilder

java.lang.Object

com.linecorp.armeria.server.consul.ConsulUpdatingListenerBuilder

All Implemented Interfaces:

ConsulConfigSetters

@UnstableApi
public final class ConsulUpdatingListenerBuilder
extends Object
implements ConsulConfigSetters

Builds a new ConsulUpdatingListener, which registers the server to Consul cluster.

Examples

 ConsulUpdatingListener listener = ConsulUpdatingListener.builder(consulUri, "myService")
                                                         .build();
 ServerBuilder sb = Server.builder();
 sb.serverListener(listener);
 

Method Summary

Modifier and Type	Method	Description
ConsulUpdatingListener	build()	Returns a newly-created ConsulUpdatingListener that registers the Server to Consul when the Server starts.
ConsulUpdatingListenerBuilder	checkInterval(Duration checkInterval)	Sets the specified Duration for checking health.
ConsulUpdatingListenerBuilder	checkIntervalMillis(long checkIntervalMillis)	Sets the specified checkIntervalMills for checking health in milliseconds.
ConsulUpdatingListenerBuilder	checkMethod(HttpMethod checkMethod)	Sets HTTP method for checking health by Consul agent.
ConsulUpdatingListenerBuilder	checkUri(String checkUri)	Sets URI for checking health by Consul agent.
ConsulUpdatingListenerBuilder	checkUri(URI checkUri)	Sets URI for checking health by Consul agent.
ConsulUpdatingListenerBuilder	consulApiVersion(String consulApiVersion)	Sets the specified Consul's API version.
ConsulUpdatingListenerBuilder	consulToken(String consulToken)	Sets the specified token for Consul's API.
ConsulUpdatingListenerBuilder	endpoint(Endpoint endpoint)	Sets the Endpoint to register.
ConsulUpdatingListenerBuilder	tags(Iterable<String> tags)	Adds a list of tags to the list of tags associated with the service on registration.
ConsulUpdatingListenerBuilder	tags(String... tags)	Adds a list of tags to the list of tags associated with the service on registration.

Methods inherited from class java.lang.Object

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

Method Details

checkUri

public ConsulUpdatingListenerBuilder checkUri(URI checkUri)

Sets URI for checking health by Consul agent.

Parameters:

checkUri - the URI for checking health of service

checkUri

public ConsulUpdatingListenerBuilder checkUri(String checkUri)

Sets URI for checking health by Consul agent.

Parameters:

checkUri - the URI for checking health of service

checkMethod

public ConsulUpdatingListenerBuilder checkMethod(HttpMethod checkMethod)

Sets HTTP method for checking health by Consul agent. If not set HttpMethod.HEAD is used by default.

Note that the checkMethod should be configured with checkUri(String). Otherwise, the build() method will throw an IllegalStateException.

Parameters:

checkMethod - the HttpMethod for checking health of service

checkInterval

public ConsulUpdatingListenerBuilder checkInterval(Duration checkInterval)

Sets the specified Duration for checking health. If not set 10000L milliseconds is used by default.

Note that the checkInterval should be configured with checkUri(URI). Otherwise, the build() method will throw an IllegalStateException.

checkIntervalMillis

public ConsulUpdatingListenerBuilder checkIntervalMillis(long checkIntervalMillis)

Sets the specified checkIntervalMills for checking health in milliseconds. If not set 10000L is used by default.

Note that the checkIntervalMillis should be configured with checkUri(URI). Otherwise, the build() method will throws IllegalStateException.

endpoint

public ConsulUpdatingListenerBuilder endpoint(Endpoint endpoint)

Sets the Endpoint to register. If not set, the current host name is used by default.

Parameters:

endpoint - the Endpoint to register

tags

public ConsulUpdatingListenerBuilder tags(String... tags)

Adds a list of tags to the list of tags associated with the service on registration.

Parameters:

tags - the tags to add

tags

public ConsulUpdatingListenerBuilder tags(Iterable<String> tags)

Adds a list of tags to the list of tags associated with the service on registration.

Parameters:

tags - the tags to add

consulApiVersion

public ConsulUpdatingListenerBuilder consulApiVersion(String consulApiVersion)

Description copied from interface: ConsulConfigSetters

Sets the specified Consul's API version.

Specified by:

consulApiVersion in interface ConsulConfigSetters

Parameters:

consulApiVersion - the version of Consul API service, default: "v1"

consulToken

public ConsulUpdatingListenerBuilder consulToken(String consulToken)

Description copied from interface: ConsulConfigSetters

Sets the specified token for Consul's API.

Specified by:

consulToken in interface ConsulConfigSetters

Parameters:

consulToken - the token for accessing Consul API, default: null

build

public ConsulUpdatingListener build()

Returns a newly-created ConsulUpdatingListener that registers the Server to Consul when the Server starts.