Package org.springframework.cloud.config.client

Class ConfigClientProperties

java.lang.Object

org.springframework.cloud.config.client.ConfigClientProperties

@ConfigurationProperties("spring.cloud.config")
public class ConfigClientProperties
extends Object

Author:

Dave Syer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigClientProperties.Credentials	Credentials properties.
static class	ConfigClientProperties.Discovery	Discovery properties.
static enum	ConfigClientProperties.MultipleUriStrategy	Enumerates possible strategies to use when multiple URLs are provided and an error occurs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION	Authorization header name.
static final String	CONFIG_DISCOVERY_ENABLED	Name of config discovery enabled property.
static final String	DEFAULT_APPLICATION	Default application name.
static final String	DEFAULT_PROFILE	Default profile value.
static final String	NAME_PLACEHOLDER	Placeholder string that allows ${spring.cloud.config.name} to override ${spring.application.name:application}.
static final String	PREFIX	Prefix for Spring Cloud Config properties.
static final String	STATE_HEADER	State header name.
static final String	TOKEN_HEADER	Token header name.

Constructor Summary

Constructors

Constructor	Description
ConfigClientProperties(org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method	Description
ConfigClientProperties.Credentials	getCredentials(int index)
ConfigClientProperties.Discovery	getDiscovery()
Map<String,String>	getHeaders()
String	getLabel()
String	getMediaType()
ConfigClientProperties.MultipleUriStrategy	getMultipleUriStrategy()
String	getName()
String	getPassword()
String	getProfile()
int	getRequestConnectTimeout()
int	getRequestReadTimeout()
org.springframework.cloud.configuration.TlsProperties	getTls()
String	getToken()
String[]	getUri()
String	getUsername()
boolean	isEnabled()
boolean	isFailFast()
boolean	isSendState()
ConfigClientProperties	override(org.springframework.core.env.Environment environment)
void	setDiscovery(ConfigClientProperties.Discovery discovery)
void	setEnabled(boolean enabled)
void	setFailFast(boolean failFast)
void	setHeaders(Map<String,String> headers)
void	setLabel(String label)
void	setMediaType(String mediaType)
void	setMultipleUriStrategy(ConfigClientProperties.MultipleUriStrategy multipleUriStrategy)
void	setName(String name)
void	setPassword(String password)
void	setProfile(String env)
void	setRequestConnectTimeout(int requestConnectTimeout)
void	setRequestReadTimeout(int requestReadTimeout)
void	setSendState(boolean sendState)
void	setTls(org.springframework.cloud.configuration.TlsProperties tls)
void	setToken(String token)
void	setUri(String[] url)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

Prefix for Spring Cloud Config properties.

See Also:

• Constant Field Values

DEFAULT_APPLICATION

public static final String DEFAULT_APPLICATION

Default application name.

See Also:

• Constant Field Values

NAME_PLACEHOLDER

public static final String NAME_PLACEHOLDER

Placeholder string that allows ${spring.cloud.config.name} to override ${spring.application.name:application}.

See Also:

• Constant Field Values

CONFIG_DISCOVERY_ENABLED

public static final String CONFIG_DISCOVERY_ENABLED

Name of config discovery enabled property.

See Also:

• Constant Field Values

TOKEN_HEADER

public static final String TOKEN_HEADER

Token header name.

See Also:

• Constant Field Values

STATE_HEADER

public static final String STATE_HEADER

State header name.

See Also:

• Constant Field Values

AUTHORIZATION

public static final String AUTHORIZATION

Authorization header name.

See Also:

• Constant Field Values

DEFAULT_PROFILE

public static final String DEFAULT_PROFILE

Default profile value.

See Also:

• Constant Field Values

Constructor Details

ConfigClientProperties

public ConfigClientProperties(org.springframework.core.env.Environment environment)

Method Details

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getUri

public String[] getUri()

setUri

public void setUri(String[] url)

getMultipleUriStrategy

public ConfigClientProperties.MultipleUriStrategy getMultipleUriStrategy()

setMultipleUriStrategy

public void setMultipleUriStrategy(ConfigClientProperties.MultipleUriStrategy multipleUriStrategy)

getName

public String getName()

setName

public void setName(String name)

getProfile

public String getProfile()

setProfile

public void setProfile(String env)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getCredentials

public ConfigClientProperties.Credentials getCredentials(int index)

getMediaType

public String getMediaType()

setMediaType

public void setMediaType(String mediaType)

getDiscovery

public ConfigClientProperties.Discovery getDiscovery()

setDiscovery

public void setDiscovery(ConfigClientProperties.Discovery discovery)

getTls

public org.springframework.cloud.configuration.TlsProperties getTls()

setTls

public void setTls(org.springframework.cloud.configuration.TlsProperties tls)

isFailFast

public boolean isFailFast()

setFailFast

public void setFailFast(boolean failFast)

getToken

public String getToken()

setToken

public void setToken(String token)

getRequestReadTimeout

public int getRequestReadTimeout()

setRequestReadTimeout

public void setRequestReadTimeout(int requestReadTimeout)

getRequestConnectTimeout

public int getRequestConnectTimeout()

setRequestConnectTimeout

public void setRequestConnectTimeout(int requestConnectTimeout)

isSendState

public boolean isSendState()

setSendState

public void setSendState(boolean sendState)

getHeaders

public Map<String,String> getHeaders()

setHeaders

public void setHeaders(Map<String,String> headers)

override

public ConfigClientProperties override(org.springframework.core.env.Environment environment)

toString

public String toString()

Overrides:

toString in class Object