com.alibaba.edas.acm

类 ConfigService

java.lang.Object

com.alibaba.edas.acm.ConfigService

public class ConfigService
extends Object

提供动态配置管理服务 Provide dynamic configuration management services

作者:

ConfigCenter

构造器概要

构造器

构造器和说明
ConfigService()

方法概要

限定符和类型	方法和说明
static void	addConfigFilter(IACMConfigFilter configFilter) 添加过滤器
static void	addGlobalListener(String dataId, String group, ConfigChangeListenerAdapter listener) 对一个dataId同时添加多个Listener，发生配置变更后会依次回调Listener
static void	addListener(String dataId, String group, ConfigChangeListenerAdapter listener) 添加对dataId的监听，在服务端修改该配置后，客户端会使用传入的listener回调应用。
static String	getConfig(String dataId, String group, long timeoutMs) 按照本地容灾, server, 本地缓存的优先级获取配置。
static Object	getConfig(String dataId, String group, long timeoutMs, Class<?> clazz) 按照本地容灾 , server , 本地缓存的优先级获取配置。
static Properties	getConfig2Properties(String dataId, String group, long timeoutMs) 按照本地容灾, server , 本地缓存的优先级获取配置。
static List<ConfigKey>	getConfigs(long timeoutMs)
static void	init()
static void	init(Properties pp)
static void	init(String endpoint, String namespace, String accessKey, String secretKey)
static boolean	publishConfig(String dataId, String group, String content) 创建或修改配置，无配置则创建，有配置则修改
static boolean	removeConfig(String dataId, String group) 删除配置

从类继承的方法 java.lang.Object

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

构造器详细资料

ConfigService

public ConfigService()

方法详细资料

init

public static void init(String endpoint,
                        String namespace,
                        String accessKey,
                        String secretKey)

init

public static void init()

init

public static void init(Properties pp)

addListener

public static void addListener(String dataId,
                               String group,
                               ConfigChangeListenerAdapter listener)

添加对dataId的监听，在服务端修改该配置后，客户端会使用传入的listener回调应用。 推荐异步处理，应用可以实现ManagerListener中的getExecutor方法，提供执行的线程池。如果为提供，则使用主线程回调， 可能会阻塞其他配置或者被其他配置阻塞。

参数:

dataId - 配置id

group - 配置分組

listener - 监听器

addGlobalListener

public static void addGlobalListener(String dataId,
                                     String group,
                                     ConfigChangeListenerAdapter listener)

对一个dataId同时添加多个Listener，发生配置变更后会依次回调Listener

参数:

dataId - 配置id

group - 配置分組

listener - 监听器

getConfig

public static String getConfig(String dataId,
                               String group,
                               long timeoutMs)
                        throws ConfigException

按照本地容灾, server, 本地缓存的优先级获取配置。超时单位是毫秒。

参数:

dataId - 配置id

group - 配置分組

timeoutMs - 获取超时时间

返回:

配置内容

抛出:

ConfigException - ConfigException

getConfig2Properties

public static Properties getConfig2Properties(String dataId,
                                              String group,
                                              long timeoutMs)
                                       throws ConfigException

按照本地容灾, server , 本地缓存的优先级获取配置。超时单位是毫秒。

参数:

dataId - 配置id

group - 配置分組

timeoutMs - 获取超时时间

返回:

配置内容 配置内容自动从string转为properties文件

抛出:

ConfigException - ConfigException

getConfigs

public static List<ConfigKey> getConfigs(long timeoutMs)
                                  throws ConfigException

抛出:

ConfigException

getConfig

public static Object getConfig(String dataId,
                               String group,
                               long timeoutMs,
                               Class<?> clazz)
                        throws ConfigException

按照本地容灾 , server , 本地缓存的优先级获取配置。超时单位是毫秒。

参数:

dataId - 配置id

group - 配置分組

timeoutMs - 获取超时时间

clazz - Object.class

返回:

配置内容 可以转化为对应java类

抛出:

ConfigException - ConfigException

addConfigFilter

public static void addConfigFilter(IACMConfigFilter configFilter)

添加过滤器

参数:

configFilter - 过滤器

publishConfig

public static boolean publishConfig(String dataId,
                                    String group,
                                    String content)
                             throws ConfigException

创建或修改配置，无配置则创建，有配置则修改

参数:

dataId - 配置ID

group - 配置分组

content - 内容

返回:

是否发布成功

抛出:

ConfigException - 写异常

removeConfig

public static boolean removeConfig(String dataId,
                                   String group)
                            throws ConfigException

删除配置

参数:

dataId - 配置ID

group - 配置分组

返回:

是否删除成功

抛出:

ConfigException - 删异常