Package io.micronaut.discovery.spring.config

Class SpringCloudClientConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration

io.micronaut.discovery.spring.config.SpringCloudClientConfiguration

@ConfigurationProperties("spring.cloud.config")
@Requires(property="spring.cloud.config.enabled",
          value="true",
          defaultValue="false")
public class SpringCloudClientConfiguration
extends io.micronaut.http.client.HttpClientConfiguration

A HttpClientConfiguration for Spring Cloud Config.

Since:

1.0

Author:

Thiago Locatelli, graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringCloudClientConfiguration.SpringCloudConnectionPoolConfiguration	The default connection pool configuration.
static class	SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration	Configuration class for Consul client config.

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

io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX
static final String	SPRING_CLOUD_CONFIG_ENDPOINT

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

DEFAULT_CONNECTION_POOL_IDLE_TIMEOUT_SECONDS, DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_QUIET_PERIOD_MILLISECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor	Description
SpringCloudClientConfiguration()	Default constructor.
SpringCloudClientConfiguration(SpringCloudClientConfiguration.SpringCloudConnectionPoolConfiguration springCloudConnectionPoolConfiguration, io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)

Method Summary

Modifier and Type	Method	Description
SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration	getConfiguration()
io.micronaut.http.client.HttpClientConfiguration.ConnectionPoolConfiguration	getConnectionPoolConfiguration()
String	getLabel()
Optional<String>	getName()
Optional<String>	getPassword()
Optional<String>	getUri()
Optional<String>	getUsername()
boolean	isFailFast()
void	setFailFast(boolean failFast)	If set to true an exception will be thrown if configuration is not found.
void	setLabel(String label)	Set the Spring Cloud config server label.
void	setName(String name)	Set the Spring Cloud config server name.
void	setPassword(String password)	Set the Spring cloud config password.
void	setUri(String uri)	Set the Spring Cloud config server uri.
void	setUsername(String username)	Set the Spring cloud config username.

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

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

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

SPRING_CLOUD_CONFIG_ENDPOINT

public static final String SPRING_CLOUD_CONFIG_ENDPOINT

See Also:

• Constant Field Values

Constructor Details

SpringCloudClientConfiguration

public SpringCloudClientConfiguration()

Default constructor.

SpringCloudClientConfiguration

@Inject
public SpringCloudClientConfiguration(SpringCloudClientConfiguration.SpringCloudConnectionPoolConfiguration springCloudConnectionPoolConfiguration,
 io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)

Parameters:

springCloudConnectionPoolConfiguration - The connection pool configuration

applicationConfiguration - The application configuration

Method Details

getConnectionPoolConfiguration

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

Specified by:

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

getConfiguration

@NonNull
public SpringCloudClientConfiguration.SpringConfigDiscoveryConfiguration getConfiguration()

Returns:

The configuration discovery configuration

getUri

@NonNull
public Optional<String> getUri()

Returns:

The spring cloud config server uri

setUri

public void setUri(String uri)

Set the Spring Cloud config server uri. Default value ("http://localhost:8888").

Parameters:

uri - Spring Cloud config server uri

getLabel

public String getLabel()

Returns:

The spring cloud config server label

getName

public Optional<String> getName()

Returns:

The spring cloud config server name. Default value is read from micronaut.application.name

getUsername

public Optional<String> getUsername()

Returns:

The spring cloud config username.

getPassword

public Optional<String> getPassword()

Returns:

The spring cloud config password.

isFailFast

public boolean isFailFast()

Returns:

Flag to indicate that failure to connect to Spring Cloud Config is fatal (default false).

setFailFast

public void setFailFast(boolean failFast)

If set to true an exception will be thrown if configuration is not found. Default value ().

Parameters:

failFast - flag to fail fast

setLabel

public void setLabel(String label)

Set the Spring Cloud config server label.

Parameters:

label - Spring Cloud config server label

setName

public void setName(String name)

Set the Spring Cloud config server name.

Parameters:

name - Spring Cloud config server name

setUsername

public void setUsername(@Nullable
 String username)

Set the Spring cloud config username.

Parameters:

username - Spring Cloud config username

setPassword

public void setPassword(@Nullable
 String password)

Set the Spring cloud config password.

Parameters:

password - Spring Cloud config password