Package org.springframework.cloud.consul.config

Class ConsulConfigProperties

java.lang.Object

org.springframework.cloud.consul.config.ConsulConfigProperties

@ConfigurationProperties("spring.cloud.consul.config")
@Validated
public class ConsulConfigProperties
extends Object

Author:

Spencer Gibb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConsulConfigProperties.Format	There are many ways in which we can specify configuration in consul i.e., Nested key value style: Where value is either a constant or part of the key (nested).
static class	ConsulConfigProperties.Watch	Consul watch properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Prefix for configuration properties.

Constructor Summary

Constructors

Constructor	Description
ConsulConfigProperties()

Method Summary

Modifier and Type	Method	Description
String	getAclToken()
@NotEmpty String	getDataKey()
@NotEmpty String	getDefaultContext()
@NotNull ConsulConfigProperties.Format	getFormat()
String	getName()
String	getPrefix()
List<String>	getPrefixes()
@NotEmpty String	getProfileSeparator()
ConsulConfigProperties.Watch	getWatch()
void	init()
boolean	isEnabled()
boolean	isFailFast()
void	setAclToken(String aclToken)
void	setDataKey(@NotEmpty String dataKey)
void	setDefaultContext(@NotEmpty String defaultContext)
void	setEnabled(boolean enabled)
void	setFailFast(boolean failFast)
void	setFormat(@NotNull ConsulConfigProperties.Format format)
void	setName(String name)
void	setPrefix(String prefix)	Deprecated.
void	setPrefixes(List<String> prefixes)
void	setProfileSeparator(@NotEmpty String profileSeparator)
void	setWatch(ConsulConfigProperties.Watch watch)
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 configuration properties.

See Also:

• Constant Field Values

Constructor Details

ConsulConfigProperties

public ConsulConfigProperties()

Method Details

init

@PostConstruct
public void init()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getPrefixes

public List<String> getPrefixes()

setPrefixes

public void setPrefixes(List<String> prefixes)

getPrefix

@DeprecatedConfigurationProperty(reason="replaced to support multiple prefixes",
                                 replacement="spring.cloud.consul.config.prefixes")
public String getPrefix()

setPrefix

@Deprecated
public void setPrefix(String prefix)

Deprecated.

getDefaultContext

@NotEmpty
public @NotEmpty String getDefaultContext()

setDefaultContext

public void setDefaultContext(@NotEmpty
 @NotEmpty String defaultContext)

getProfileSeparator

@NotEmpty
public @NotEmpty String getProfileSeparator()

setProfileSeparator

public void setProfileSeparator(@NotEmpty
 @NotEmpty String profileSeparator)

getFormat

@NotNull
public @NotNull ConsulConfigProperties.Format getFormat()

setFormat

public void setFormat(@NotNull
 @NotNull ConsulConfigProperties.Format format)

getDataKey

@NotEmpty
public @NotEmpty String getDataKey()

setDataKey

public void setDataKey(@NotEmpty
 @NotEmpty String dataKey)

getAclToken

public String getAclToken()

setAclToken

public void setAclToken(String aclToken)

getWatch

public ConsulConfigProperties.Watch getWatch()

setWatch

public void setWatch(ConsulConfigProperties.Watch watch)

isFailFast

public boolean isFailFast()

setFailFast

public void setFailFast(boolean failFast)

getName

public String getName()

setName

public void setName(String name)

toString

public String toString()

Overrides:

toString in class Object