Package io.micronaut.aws.distributedconfiguration

Class AwsDistributedConfigurationProperties

java.lang.Object

io.micronaut.aws.distributedconfiguration.AwsDistributedConfigurationProperties

All Implemented Interfaces:

AwsDistributedConfiguration

@ConfigurationProperties("aws.distributed-configuration")
public class AwsDistributedConfigurationProperties
extends Object
implements AwsDistributedConfiguration

ConfigurationProperties implementation of AwsDistributedConfiguration.

Since:

2.8.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COMMON_APPLICATION_NAME
static final String	DEFAULT_DELIMETER
static final String	DEFAULT_PREFIX
static final boolean	DEFAULT_SEARCH_ACTIVE_ENVIRONMENTS
static final boolean	DEFAULT_SEARCH_COMMON_APPLICATION
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
AwsDistributedConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getCommonApplicationName()
String	getDelimiter()	Delimiter after prefix and application name.
String	getPrefix()
List<String>	getPrefixes()
boolean	isSearchActiveEnvironments()
boolean	isSearchCommonApplication()
void	setCommonApplicationName(String commonApplicationName)	Default Application name.
void	setDelimiter(String delimiter)	Delimiter for AWS Distributed Configuration resources names.
void	setPrefix(String prefix)	Prefix for AWS Distributed Configuration resources names.
void	setPrefixes(List<String> prefixes)
void	setSearchActiveEnvironments(boolean searchActiveEnvironments)	Search additional paths suffixed with each active environment.
void	setSearchCommonApplication(boolean searchCommonApplication)	Whether paths for the AwsDistributedConfiguration.getCommonApplicationName() should be searched or not.

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

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

See Also:

• Constant Field Values

DEFAULT_COMMON_APPLICATION_NAME

public static final String DEFAULT_COMMON_APPLICATION_NAME

See Also:

• Constant Field Values

DEFAULT_DELIMETER

public static final String DEFAULT_DELIMETER

See Also:

• Constant Field Values

DEFAULT_SEARCH_COMMON_APPLICATION

public static final boolean DEFAULT_SEARCH_COMMON_APPLICATION

See Also:

• Constant Field Values

DEFAULT_SEARCH_ACTIVE_ENVIRONMENTS

public static final boolean DEFAULT_SEARCH_ACTIVE_ENVIRONMENTS

See Also:

• Constant Field Values

Constructor Details

AwsDistributedConfigurationProperties

public AwsDistributedConfigurationProperties()

Method Details

getDelimiter

@NonNull
public String getDelimiter()

Description copied from interface: AwsDistributedConfiguration

Delimiter after prefix and application name. For /config/application_dev/micronaut.security.oauth2.clients.mycompanyauth.client-secret delimiter will be / The character between /config/application_dev and micronaut.security.oauth2.clients.mycompanyauth.client-secret

Specified by:

getDelimiter in interface AwsDistributedConfiguration

Returns:

Delimiter after AwsDistributedConfiguration.getPrefix() and application name for AWS Distributed Configuration resources names.

setDelimiter

public void setDelimiter(@NonNull
 String delimiter)

Delimiter for AWS Distributed Configuration resources names. Default value ("/").

Parameters:

delimiter - Delimiter for AWS Distributed Configuration resources names.

isSearchActiveEnvironments

public boolean isSearchActiveEnvironments()

Specified by:

isSearchActiveEnvironments in interface AwsDistributedConfiguration

Returns:

Search active environment paths

setSearchActiveEnvironments

public void setSearchActiveEnvironments(boolean searchActiveEnvironments)

Search additional paths suffixed with each active environment. e.g. /config/application_ec2 Default value (true).

Parameters:

searchActiveEnvironments - True if paths suffixed with micronaut environments should be searched

isSearchCommonApplication

public boolean isSearchCommonApplication()

Specified by:

isSearchCommonApplication in interface AwsDistributedConfiguration

Returns:

Whether paths for the AwsDistributedConfiguration.getCommonApplicationName() should be searched or not.

setSearchCommonApplication

public void setSearchCommonApplication(boolean searchCommonApplication)

Whether paths for the AwsDistributedConfiguration.getCommonApplicationName() should be searched or not. Default value (true).

Parameters:

searchCommonApplication - Whether paths for the AwsDistributedConfiguration.getCommonApplicationName() should be searched or not.

getPrefixes

@NonNull
public List<String> getPrefixes()

Specified by:

getPrefixes in interface AwsDistributedConfiguration

Returns:

List of prefixes for AWS Distributed Configuration resources names. If it is non-empty, AwsDistributedConfiguration.getPrefix() is not used.

setPrefixes

public void setPrefixes(@NonNull
 List<String> prefixes)

getPrefix

@NonNull
public String getPrefix()

Specified by:

getPrefix in interface AwsDistributedConfiguration

Returns:

Prefix for AWS Distributed Configuration resources names. For example `/config/`. If AwsDistributedConfiguration.getPrefixes() returns non-empty list, this value is ignored.

setPrefix

public void setPrefix(@NonNull
 String prefix)

Prefix for AWS Distributed Configuration resources names. Default ("/config/")

Parameters:

prefix - Prefix for AWS Distributed Configuration resources names. For example `/config/`

getCommonApplicationName

@NonNull
public String getCommonApplicationName()

Specified by:

getCommonApplicationName in interface AwsDistributedConfiguration

Returns:

Default Application name. e.g. application

setCommonApplicationName

public void setCommonApplicationName(@NonNull
 String commonApplicationName)

Default Application name. Default value ("application".

Parameters:

commonApplicationName - Default Application name. e.g. application