com.alibaba.nacos.api.config

Interface ConfigService

public interface ConfigService

Config Interface

Author:

Nacos

Method Summary

Modifier and Type	Method and Description
void	addListener(String dataId, String group, Listener listener) Add a listener to the configuration, after the server to modify the configuration, the client will use the incoming listener callback.
String	getConfig(String dataId, String group, long timeoutMs) Get Configuration
String	getServerStatus() server health info
boolean	publishConfig(String dataId, String group, String content) publish config.
boolean	removeConfig(String dataId, String group) Remove Config
void	removeListener(String dataId, String group, Listener listener) Remove Listener

Method Detail

getConfig

String getConfig(String dataId,
                 String group,
                 long timeoutMs)
          throws NacosException

Get Configuration

Parameters:

dataId - Config ID

group - Config Group

timeoutMs - read timeout

Returns:

config value

Throws:

NacosException - NacosException

addListener

void addListener(String dataId,
                 String group,
                 Listener listener)
          throws NacosException

Add a listener to the configuration, after the server to modify the configuration, the client will use the incoming listener callback. Recommended asynchronous processing, the application can implement the getExecutor method in the ManagerListener, provide a thread pool of execution. If provided, use the main thread callback, May block other configurations or be blocked by other configurations.

Parameters:

dataId - Config ID

group - Config Group

listener - listener

Throws:

NacosException - NacosException

publishConfig

boolean publishConfig(String dataId,
                      String group,
                      String content)
               throws NacosException

publish config.

Parameters:

dataId - Config ID

group - Config Group

content - Config Content

Returns:

Whether publish

Throws:

NacosException - NacosException

removeConfig

boolean removeConfig(String dataId,
                     String group)
              throws NacosException

Remove Config

Parameters:

dataId - Config ID

group - Config Group

Returns:

whether remove

Throws:

NacosException - NacosException

removeListener

void removeListener(String dataId,
                    String group,
                    Listener listener)

Remove Listener

Parameters:

dataId - Config ID

group - Config Group

listener - listener

getServerStatus

String getServerStatus()

server health info

Returns:

whether health