Class ConsulConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration

io.micronaut.discovery.client.DiscoveryClientConfiguration

io.micronaut.discovery.consul.ConsulConfiguration

@RequiresConsul
@ConfigurationProperties("consul.client")
@Requires(property="consul.client")
public class ConsulConfiguration
extends DiscoveryClientConfiguration

Configuration for consul.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsulConfiguration.ConsulConfigDiscoveryConfiguration	Configuration class for Consul client config.
static class	ConsulConfiguration.ConsulConnectionPoolConfiguration	The default connection pool configuration.
static class	ConsulConfiguration.ConsulDiscoveryConfiguration	Configuration class for Consul client discovery.
static class	ConsulConfiguration.ConsulRegistrationConfiguration	Configuration class for Consul client registration.

Nested classes/interfaces inherited from class io.micronaut.http.client.HttpClientConfiguration

io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration, io.micronaut.http.client.HttpClientConfiguration.DnsResolutionMode, io.micronaut.http.client.HttpClientConfiguration.Http2ClientConfiguration, io.micronaut.http.client.HttpClientConfiguration.WebSocketCompressionConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The prefix to use for all Consul settings.

Fields inherited from class io.micronaut.http.client.HttpClientConfiguration

DEFAULT_ALLOW_BLOCK_EVENT_LOOP, DEFAULT_CONNECTION_POOL_IDLE_TIMEOUT_SECONDS, DEFAULT_DNS_RESOLUTION_MODE, DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_QUIET_PERIOD_MILLISECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor	Description
ConsulConfiguration()	Default Consult configuration.
ConsulConfiguration(ConsulConfiguration.ConsulConnectionPoolConfiguration consulConnectionPoolConfiguration, io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAclToken()
Optional<String>	getAslToken()	Deprecated, for removal: This API element is subject to removal in a future version. Use getAclToken().
ConsulConfiguration.ConsulConfigDiscoveryConfiguration	getConfiguration()
io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration	getConnectionPoolConfiguration()
ConsulConfiguration.ConsulDiscoveryConfiguration	getDiscovery()
ConsulConfiguration.ConsulRegistrationConfiguration	getRegistration()
protected String	getServiceID()
boolean	isHealthCheck()
void	setAclToken(String aclToken)
void	setAslToken(String aslToken)	Deprecated, for removal: This API element is subject to removal in a future version. Use setAclToken(String).
void	setConfiguration(ConsulConfiguration.ConsulConfigDiscoveryConfiguration configuration)
void	setDiscovery(ConsulConfiguration.ConsulDiscoveryConfiguration discovery)
void	setHealthCheck(boolean healthCheck)	Sets whether the Consul server should be considered for health checks.
void	setRegistration(ConsulConfiguration.ConsulRegistrationConfiguration registration)
String	toString()

Methods inherited from class DiscoveryClientConfiguration

getAllZones, getContextPath, getDefaultZone, getHost, getPort, getServiceId, isSecure, isShouldUseDns, setContextPath, setDefaultZone, setHost, setPort, setSecure, setShouldUseDns, setZones

Methods inherited from class io.micronaut.http.client.HttpClientConfiguration

getAddressResolverGroupName, getAlpnModes, getChannelOptions, getConnectionPoolIdleTimeout, getConnectTimeout, getConnectTtl, getDefaultCharset, getDnsResolutionMode, getEventLoopGroup, getHttp2Configuration, getHttpVersion, getLoggerName, getLogLevel, getMaxChunkSize, getMaxContentLength, getMaxHeaderSize, getMaxInitialLineLength, getNumOfThreads, getPcapLoggingPathPattern, getPlaintextMode, getProxyAddress, getProxyPassword, getProxySelector, getProxyType, getProxyUsername, getReadIdleTimeout, getReadTimeout, getRequestTimeout, getShutdownQuietPeriod, getShutdownTimeout, getSslConfiguration, getThreadFactory, getWebSocketCompressionConfiguration, isAllowBlockEventLoop, isDecompressionEnabled, isExceptionOnErrorStatus, isFollowRedirects, resolveProxy, setAddressResolverGroupName, setAllowBlockEventLoop, setAlpnModes, setChannelOptions, setConnectionPoolIdleTimeout, setConnectTimeout, setConnectTtl, setDecompressionEnabled, setDefaultCharset, setDnsResolutionMode, setEventLoopGroup, setExceptionOnErrorStatus, setFollowRedirects, setHttpVersion, setLoggerName, setLogLevel, setMaxChunkSize, setMaxContentLength, setMaxHeaderSize, setMaxInitialLineLength, setNumOfThreads, setPcapLoggingPathPattern, setPlaintextMode, setProxyAddress, setProxyPassword, setProxySelector, setProxyType, setProxyUsername, setReadIdleTimeout, setReadTimeout, setRequestTimeout, setShutdownQuietPeriod, setShutdownTimeout, setSslConfiguration, setThreadFactory

Methods inherited from class Object

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

Field Details

PREFIX

public static final String PREFIX

The prefix to use for all Consul settings.

See Also:

• Constant Field Values

Constructor Details

ConsulConfiguration

public ConsulConfiguration()

Default Consult configuration.

ConsulConfiguration

@Inject
public ConsulConfiguration(ConsulConfiguration.ConsulConnectionPoolConfiguration consulConnectionPoolConfiguration,
 io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)

Parameters:

consulConnectionPoolConfiguration - The connection pool configuration

applicationConfiguration - The application configuration

Method Details

isHealthCheck

public boolean isHealthCheck()

Returns:

Whether the Consul server should be considered for health checks.

See Also:

• ConsulHealthIndicator

setHealthCheck

public void setHealthCheck(boolean healthCheck)

Sets whether the Consul server should be considered for health checks.

Parameters:

healthCheck - True if it should

See Also:

• ConsulHealthIndicator

getConnectionPoolConfiguration

public io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration getConnectionPoolConfiguration()

Specified by:

getConnectionPoolConfiguration in class io.micronaut.http.client.HttpClientConfiguration

getConfiguration

public ConsulConfiguration.ConsulConfigDiscoveryConfiguration getConfiguration()

Returns:

The configuration discovery configuration

setConfiguration

@Inject
public void setConfiguration(ConsulConfiguration.ConsulConfigDiscoveryConfiguration configuration)

Parameters:

configuration - The ConsulConfiguration.ConsulConfigDiscoveryConfiguration

getAslToken

@Deprecated(since="5.0",
            forRemoval=true)
public Optional<String> getAslToken()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getAclToken().

Returns:

The token to include in all requests as the X-Consul-Token header

setAslToken

@Deprecated(since="5.0",
            forRemoval=true)
public void setAslToken(String aslToken)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setAclToken(String).

Parameters:

aslToken - The asl token

getAclToken

public Optional<String> getAclToken()

Returns:

The token to include in all requests as the X-Consul-Token header

setAclToken

public void setAclToken(String aclToken)

Parameters:

aclToken - The asl token

getRegistration

public ConsulConfiguration.ConsulRegistrationConfiguration getRegistration()

Specified by:

getRegistration in class DiscoveryClientConfiguration

Returns:

The registration configuration

setRegistration

@Inject
public void setRegistration(ConsulConfiguration.ConsulRegistrationConfiguration registration)

Parameters:

registration - The ConsulConfiguration.ConsulRegistrationConfiguration

getDiscovery

public ConsulConfiguration.ConsulDiscoveryConfiguration getDiscovery()

Specified by:

getDiscovery in class DiscoveryClientConfiguration

Returns:

The discovery configuration

setDiscovery

@Inject
public void setDiscovery(ConsulConfiguration.ConsulDiscoveryConfiguration discovery)

Parameters:

discovery - The ConsulConfiguration.ConsulDiscoveryConfiguration

getServiceID

protected String getServiceID()

Specified by:

getServiceID in class DiscoveryClientConfiguration

Returns:

The serviceID

toString

public String toString()

Overrides:

toString in class DiscoveryClientConfiguration