程序包 com.alibaba.nacos.client.config.impl

类 ConfigTransportClient

java.lang.Object

com.alibaba.nacos.client.config.impl.ConfigTransportClient

直接已知子类:

ClientWorker.ConfigRpcTransportClient

public abstract class ConfigTransportClient
extends java.lang.Object

config transport client,include basic operations of config module.

版本:

$Id: ConfigTransportClient.java, v 0.1 2020年08月24日 2:01 PM liuzunfei Exp $

作者:

liuzunfei

字段概要

字段

修饰符和类型	字段	说明
private static java.lang.String	CONFIG_INFO_HEADER
private static java.lang.String	DEFAULT_CONFIG_INFO
(专用程序包) java.lang.String	encode
(专用程序包) java.util.concurrent.ScheduledExecutorService	executor
private int	maxRetry
(专用程序包) java.util.Properties	properties
private long	securityInfoRefreshIntervalMills
protected SecurityProxy	securityProxy
(专用程序包) ServerListManager	serverListManager
(专用程序包) java.lang.String	tenant

构造器概要

构造器

构造器	说明
ConfigTransportClient(java.util.Properties properties, ServerListManager serverListManager)

方法概要

修饰符和类型	方法	说明
protected com.alibaba.nacos.plugin.auth.api.RequestResource	buildResource(java.lang.String tenant, java.lang.String group, java.lang.String dataId)	Build the resource for current request.
abstract void	executeConfigListen()	listen change .
protected java.util.Map<java.lang.String,java.lang.String>	getCommonHeader()	get common header.
java.lang.String	getEncode()	get encode.
abstract java.lang.String	getName()	get client name.
protected java.util.Map<java.lang.String,java.lang.String>	getSecurityHeaders(com.alibaba.nacos.plugin.auth.api.RequestResource resource)
java.lang.String	getTenant()	get tenant.
private void	initMaxRetry(java.util.Properties properties)
abstract void	notifyListenConfig()	notify listen config.
abstract boolean	publishConfig(java.lang.String dataId, java.lang.String group, java.lang.String tenant, java.lang.String appName, java.lang.String tag, java.lang.String betaIps, java.lang.String content, java.lang.String encryptedDataKey, java.lang.String casMd5, java.lang.String type)	publish config.
abstract ConfigResponse	queryConfig(java.lang.String dataId, java.lang.String group, java.lang.String tenat, long readTimeous, boolean notify)	query config.
abstract void	removeCache(java.lang.String dataId, java.lang.String group)	remove cache implements.
abstract boolean	removeConfig(java.lang.String dataid, java.lang.String group, java.lang.String tenat, java.lang.String tag)	remove config.
void	setExecutor(java.util.concurrent.ScheduledExecutorService executor)
void	shutdown()
void	start()	base start client.
abstract void	startInternal()	start client inner.

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

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

字段详细资料

CONFIG_INFO_HEADER

private static final java.lang.String CONFIG_INFO_HEADER

另请参阅:

常量字段值

DEFAULT_CONFIG_INFO

private static final java.lang.String DEFAULT_CONFIG_INFO

另请参阅:

常量字段值

encode

java.lang.String encode

tenant

java.lang.String tenant

executor

java.util.concurrent.ScheduledExecutorService executor

serverListManager

final ServerListManager serverListManager

properties

final java.util.Properties properties

maxRetry

private int maxRetry

securityInfoRefreshIntervalMills

private final long securityInfoRefreshIntervalMills

securityProxy

protected SecurityProxy securityProxy

构造器详细资料

ConfigTransportClient

public ConfigTransportClient(java.util.Properties properties,
                             ServerListManager serverListManager)

方法详细资料

shutdown

public void shutdown()
              throws com.alibaba.nacos.api.exception.NacosException

抛出:

com.alibaba.nacos.api.exception.NacosException

buildResource

protected com.alibaba.nacos.plugin.auth.api.RequestResource buildResource(java.lang.String tenant,
                                                                          java.lang.String group,
                                                                          java.lang.String dataId)

Build the resource for current request.

参数:

tenant - tenant of config

group - group of config

dataId - dataId of config

返回:

resource

getSecurityHeaders

protected java.util.Map<java.lang.String,java.lang.String> getSecurityHeaders(com.alibaba.nacos.plugin.auth.api.RequestResource resource)
                                                                             throws java.lang.Exception

抛出:

java.lang.Exception

getCommonHeader

protected java.util.Map<java.lang.String,java.lang.String> getCommonHeader()

get common header.

返回:

headers.

initMaxRetry

private void initMaxRetry(java.util.Properties properties)

setExecutor

public void setExecutor(java.util.concurrent.ScheduledExecutorService executor)

start

public void start()
           throws com.alibaba.nacos.api.exception.NacosException

base start client.

抛出:

com.alibaba.nacos.api.exception.NacosException

startInternal

public abstract void startInternal()
                            throws com.alibaba.nacos.api.exception.NacosException

start client inner.

抛出:

com.alibaba.nacos.api.exception.NacosException - exception may throw.

getName

public abstract java.lang.String getName()

get client name.

返回:

name.

getEncode

public java.lang.String getEncode()

get encode.

返回:

encode.

getTenant

public java.lang.String getTenant()

get tenant.

返回:

tenant.

notifyListenConfig

public abstract void notifyListenConfig()

notify listen config.

executeConfigListen

public abstract void executeConfigListen()

listen change .

removeCache

public abstract void removeCache(java.lang.String dataId,
                                 java.lang.String group)

remove cache implements.

参数:

dataId - dataId.

group - group

queryConfig

public abstract ConfigResponse queryConfig(java.lang.String dataId,
                                           java.lang.String group,
                                           java.lang.String tenat,
                                           long readTimeous,
                                           boolean notify)
                                    throws com.alibaba.nacos.api.exception.NacosException

query config.

参数:

dataId - dataId.

group - group.

tenat - tenat.

readTimeous - readTimeous.

notify - query for notify sync.

返回:

content.

抛出:

com.alibaba.nacos.api.exception.NacosException - throw where query fail .

publishConfig

public abstract boolean publishConfig(java.lang.String dataId,
                                      java.lang.String group,
                                      java.lang.String tenant,
                                      java.lang.String appName,
                                      java.lang.String tag,
                                      java.lang.String betaIps,
                                      java.lang.String content,
                                      java.lang.String encryptedDataKey,
                                      java.lang.String casMd5,
                                      java.lang.String type)
                               throws com.alibaba.nacos.api.exception.NacosException

publish config.

参数:

dataId - dataId.

group - group.

tenant - tenant.

appName - appName.

tag - tag.

betaIps - betaIps.

content - content.

encryptedDataKey - encryptedDataKey

casMd5 - casMd5.

type - type.

返回:

success or not.

抛出:

com.alibaba.nacos.api.exception.NacosException - throw where publish fail.

removeConfig

public abstract boolean removeConfig(java.lang.String dataid,
                                     java.lang.String group,
                                     java.lang.String tenat,
                                     java.lang.String tag)
                              throws com.alibaba.nacos.api.exception.NacosException

remove config.

参数:

dataid - dataid.

group - group.

tenat - tenat.

tag - tag.

返回:

success or not.

抛出:

com.alibaba.nacos.api.exception.NacosException - throw where publish fail.