com.alibaba.cloud.nacos

Class NacosConfigProperties

java.lang.Object

com.alibaba.cloud.nacos.NacosConfigProperties

@ConfigurationProperties(value="spring.cloud.nacos.config")
public class NacosConfigProperties
extends Object

Nacos properties.

Author:

leijuan, xiaojing, pbting, lyuzb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NacosConfigProperties.Config

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAS COMMAS , .
static String	DEFAULT_NAMESPACE Nacos default namespace .
static String	PREFIX Prefix of NacosConfigProperties.
static String	SEPARATOR SEPARATOR , .

Constructor Summary

Constructors

Constructor and Description
NacosConfigProperties()

Method Summary

Modifier and Type	Method and Description
Properties	assembleConfigServiceProperties() assemble properties for configService.
com.alibaba.nacos.api.config.ConfigService	configServiceInstance() Deprecated.
String	getAccessKey()
String	getClusterName()
String	getConfigLongPollTimeout()
String	getConfigRetryTime()
Properties	getConfigServiceProperties() Deprecated.
String	getContextPath()
Boolean	getEnableRemoteSyncConfig()
String	getEncode()
String	getEndpoint()
org.springframework.core.env.Environment	getEnvironment()
List<NacosConfigProperties.Config>	getExtConfig() Deprecated.
List<NacosConfigProperties.Config>	getExtensionConfigs()
String	getFileExtension()
String	getGroup()
String	getMaxRetry()
String	getName()
String	getNamespace()
String	getPassword()
String	getPrefix()
String	getRamRoleName()
String	getRefreshableDataids() Deprecated.
String	getSecretKey()
String	getServerAddr()
List<NacosConfigProperties.Config>	getSharedConfigs()
String	getSharedDataids() Deprecated.
int	getTimeout()
String	getUsername()
void	init()
boolean	isRefreshEnabled()
void	setAccessKey(String accessKey)
void	setClusterName(String clusterName)
void	setConfigLongPollTimeout(String configLongPollTimeout)
void	setConfigRetryTime(String configRetryTime)
void	setContextPath(String contextPath)
void	setEnableRemoteSyncConfig(Boolean enableRemoteSyncConfig)
void	setEncode(String encode)
void	setEndpoint(String endpoint)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setExtConfig(List<NacosConfigProperties.Config> extConfig) Deprecated.
void	setExtensionConfigs(List<NacosConfigProperties.Config> extensionConfigs)
void	setFileExtension(String fileExtension)
void	setGroup(String group)
void	setMaxRetry(String maxRetry)
void	setName(String name)
void	setNamespace(String namespace)
void	setPassword(String password)
void	setPrefix(String prefix)
void	setRamRoleName(String ramRoleName)
void	setRefreshableDataids(String refreshableDataids) Deprecated.
void	setRefreshEnabled(boolean refreshEnabled)
void	setSecretKey(String secretKey)
void	setServerAddr(String serverAddr)
void	setSharedConfigs(List<NacosConfigProperties.Config> sharedConfigs)
void	setSharedDataids(String sharedDataids) Deprecated.
void	setTimeout(int timeout)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

Prefix of NacosConfigProperties.

See Also:

Constant Field Values

COMMAS

public static final String COMMAS

COMMAS , .

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

SEPARATOR , .

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

Nacos default namespace .

See Also:

Constant Field Values

Constructor Detail

NacosConfigProperties

public NacosConfigProperties()

Method Detail

init

@PostConstruct
public void init()

getServerAddr

public String getServerAddr()

setServerAddr

public void setServerAddr(String serverAddr)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getFileExtension

public String getFileExtension()

setFileExtension

public void setFileExtension(String fileExtension)

getGroup

public String getGroup()

setGroup

public void setGroup(String group)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getMaxRetry

public String getMaxRetry()

setMaxRetry

public void setMaxRetry(String maxRetry)

getConfigLongPollTimeout

public String getConfigLongPollTimeout()

setConfigLongPollTimeout

public void setConfigLongPollTimeout(String configLongPollTimeout)

getConfigRetryTime

public String getConfigRetryTime()

setConfigRetryTime

public void setConfigRetryTime(String configRetryTime)

getEnableRemoteSyncConfig

public Boolean getEnableRemoteSyncConfig()

setEnableRemoteSyncConfig

public void setEnableRemoteSyncConfig(Boolean enableRemoteSyncConfig)

getEndpoint

public String getEndpoint()

setEndpoint

public void setEndpoint(String endpoint)

getNamespace

public String getNamespace()

setNamespace

public void setNamespace(String namespace)

getAccessKey

public String getAccessKey()

setAccessKey

public void setAccessKey(String accessKey)

getSecretKey

public String getSecretKey()

setSecretKey

public void setSecretKey(String secretKey)

getRamRoleName

public String getRamRoleName()

setRamRoleName

public void setRamRoleName(String ramRoleName)

getEncode

public String getEncode()

setEncode

public void setEncode(String encode)

getContextPath

public String getContextPath()

setContextPath

public void setContextPath(String contextPath)

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

getName

public String getName()

setName

public void setName(String name)

getEnvironment

public org.springframework.core.env.Environment getEnvironment()

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

getSharedConfigs

public List<NacosConfigProperties.Config> getSharedConfigs()

setSharedConfigs

public void setSharedConfigs(List<NacosConfigProperties.Config> sharedConfigs)

getExtensionConfigs

public List<NacosConfigProperties.Config> getExtensionConfigs()

setExtensionConfigs

public void setExtensionConfigs(List<NacosConfigProperties.Config> extensionConfigs)

isRefreshEnabled

public boolean isRefreshEnabled()

setRefreshEnabled

public void setRefreshEnabled(boolean refreshEnabled)

getSharedDataids

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#sharedConfigs and not use it at the same time.",
                                 replacement="spring.cloud.nacos.config.shared-configs[x]")
public String getSharedDataids()

Deprecated.

recommend to use sharedConfigs .

Returns:

string

setSharedDataids

@Deprecated
public void setSharedDataids(String sharedDataids)

Deprecated.

recommend to use sharedConfigs and not use it at the same time .

Parameters:

sharedDataids - the dataids for configurable multiple shared configurations , multiple separated by commas .

getRefreshableDataids

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#sharedConfigs and not use it at the same time.",
                                 replacement="spring.cloud.nacos.config.shared-configs[x].refresh")
public String getRefreshableDataids()

Deprecated.

Not providing support,the need to refresh is specified by the respective refresh configuration and not use it at the same time .

Returns:

string

setRefreshableDataids

@Deprecated
public void setRefreshableDataids(String refreshableDataids)

Deprecated.

Not providing support,the need to refresh is specified by the respective refresh configuration and not use it at the same time .

Parameters:

refreshableDataids - refreshable dataids ,multiple separated by commas .

getExtConfig

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#extensionConfigs and not use it at the same time .",
                                 replacement="spring.cloud.nacos.config.extension-configs[x]")
public List<NacosConfigProperties.Config> getExtConfig()

Deprecated.

recommend to use extensionConfigs and not use it at the same time .

Returns:

extensionConfigs

setExtConfig

@Deprecated
public void setExtConfig(List<NacosConfigProperties.Config> extConfig)

Deprecated.

configServiceInstance

@Deprecated
public com.alibaba.nacos.api.config.ConfigService configServiceInstance()

Deprecated.

recommend to use NacosConfigManager.getConfigService().

Returns:

ConfigService

getConfigServiceProperties

@Deprecated
public Properties getConfigServiceProperties()

Deprecated.

recommend to use assembleConfigServiceProperties().

Returns:

ConfigServiceProperties

assembleConfigServiceProperties

public Properties assembleConfigServiceProperties()

assemble properties for configService. (cause by rename : Remove the interference of auto prompts when writing,because autocue is based on get method.

Returns:

properties

toString

public String toString()

Overrides:

toString in class Object