io.micronaut.discovery.client

Class DiscoveryClientConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration

io.micronaut.discovery.client.DiscoveryClientConfiguration

Direct Known Subclasses:

ConsulConfiguration, EurekaConfiguration

public abstract class DiscoveryClientConfiguration
extends HttpClientConfiguration

Abstract class for all DiscoveryClient configurations.

Since:

1.0

Author:

graemerocher

Nested Class Summary

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

HttpClientConfiguration.ConnectionPoolConfiguration

Field Summary

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

DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
DiscoveryClientConfiguration() Default constructor.
DiscoveryClientConfiguration(ApplicationConfiguration applicationConfiguration)

Method Summary

Modifier and Type	Method and Description
java.util.List<ServiceInstance>	getAllZones()
java.util.Optional<java.lang.String>	getContextPath()
java.util.List<ServiceInstance>	getDefaultZone()
abstract DiscoveryConfiguration	getDiscovery()
java.lang.String	getHost()
int	getPort()
abstract RegistrationConfiguration	getRegistration()
java.util.Optional<java.lang.String>	getServiceId()
protected abstract java.lang.String	getServiceID()
boolean	isSecure()
boolean	isShouldUseDns() Whether DNS should be used to resolve the discovery servers.
void	setContextPath(java.lang.String contextPath) Sets the context path.
void	setDefaultZone(java.util.List<java.net.URL> defaultZone) Sets the Discovery servers to use for the default zone.
void	setHost(java.lang.String host)
void	setPort(int port)
void	setSecure(boolean secure)
void	setShouldUseDns(boolean shouldUseDns) Whether DNS should be used to resolve the discovery servers.
void	setZones(java.util.Map<java.lang.String,java.util.List<java.net.URL>> zones) Configures Discovery servers in other zones.
java.lang.String	toString()

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

getChannelOptions, getConnectionPoolConfiguration, getConnectTimeout, getConnectTtl, getDefaultCharset, getEventLoopGroup, getHttpVersion, getLoggerName, getLogLevel, getMaxContentLength, getNumOfThreads, getProxyAddress, getProxyPassword, getProxySelector, getProxyType, getProxyUsername, getReadIdleTimeout, getReadTimeout, getShutdownTimeout, getSslConfiguration, getThreadFactory, isExceptionOnErrorStatus, isFollowRedirects, resolveProxy, setChannelOptions, setConnectTimeout, setConnectTtl, setDefaultCharset, setEventLoopGroup, setExceptionOnErrorStatus, setFollowRedirects, setHttpVersion, setLoggerName, setLogLevel, setMaxContentLength, setNumOfThreads, setProxyAddress, setProxyPassword, setProxySelector, setProxyType, setProxyUsername, setReadIdleTimeout, setReadTimeout, setShutdownTimeout, setSslConfiguration, setThreadFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryClientConfiguration

public DiscoveryClientConfiguration()

Default constructor.

DiscoveryClientConfiguration

public DiscoveryClientConfiguration(ApplicationConfiguration applicationConfiguration)

Parameters:

applicationConfiguration - The application configuration.

Method Detail

isShouldUseDns

public boolean isShouldUseDns()

Whether DNS should be used to resolve the discovery servers.

Returns:

True if DNS should be used.

setShouldUseDns

public void setShouldUseDns(boolean shouldUseDns)

Whether DNS should be used to resolve the discovery servers.

Parameters:

shouldUseDns - True if DNS should be used.

getContextPath

public java.util.Optional<java.lang.String> getContextPath()

Returns:

The context path to use

setContextPath

public void setContextPath(java.lang.String contextPath)

Sets the context path.

Parameters:

contextPath - The context path

getServiceId

public java.util.Optional<java.lang.String> getServiceId()

Returns:

Resolves the service ID to use

getDefaultZone

public java.util.List<ServiceInstance> getDefaultZone()

Returns:

The Discovery servers within the default zone

setDefaultZone

public void setDefaultZone(java.util.List<java.net.URL> defaultZone)

Sets the Discovery servers to use for the default zone.

Parameters:

defaultZone - The default zone

getAllZones

public java.util.List<ServiceInstance> getAllZones()

Returns:

The Discovery servers within all zones

setZones

public void setZones(java.util.Map<java.lang.String,java.util.List<java.net.URL>> zones)

Configures Discovery servers in other zones.

Parameters:

zones - The zones

isSecure

public boolean isSecure()

Returns:

Is the discovery server exposed over HTTPS (defaults to false)

setSecure

public void setSecure(boolean secure)

Parameters:

secure - Set if the discovery server is exposed over HTTPS

getHost

@NonNull
public java.lang.String getHost()

Returns:

The Discovery server instance host name. Defaults to 'localhost'.

setHost

public void setHost(java.lang.String host)

Parameters:

host - The Discovery server host name

getPort

public int getPort()

Returns:

The default Discovery server port

setPort

public void setPort(int port)

Parameters:

port - The port for the Discovery server

getDiscovery

@NonNull
public abstract DiscoveryConfiguration getDiscovery()

Returns:

The default discovery configuration

getRegistration

@Nullable
public abstract RegistrationConfiguration getRegistration()

Returns:

The default registration configuration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getServiceID

protected abstract java.lang.String getServiceID()

Returns:

The ID of the DiscoveryClient