SubscriberRegistration ([com.taobao.configserver]-[config-client]-[2.0.4-open-sock5] 2.0.4-open-sock5 API)

java.lang.Object
- com.taobao.config.client.SubscriberRegistration

```
public class SubscriberRegistration
extends Object
```
《订阅者登记表》对于每一个订阅者，需要使用唯一的订阅者登记表进行注册。每一份登记表只能注册一次，重复注册将被判定为无效（注册时将返回null）；使用不同的登记表进行注册，即使其中登记的信息完全相同，也将被视作两个不同的订阅者。

从以下版本开始:

1.2

作者:

wufeng

构造器概要

构造器
构造器和说明
`SubscriberRegistration(String subscriberName, String dataId)` 填写一份新的订阅者登记表
`SubscriberRegistration(String subscriberName, String dataId, String datumId)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(Object obj)`
`Set<Map.Entry<String,Serializable>>`	`getAllAttributes()`
`<V extends Serializable> V`	`getAttribute(String attribute)`
`protected String`	`getClientId()`
`protected String`	`getClientName()`
`String`	`getDataId()`
`String`	`getDatumId()`
`String`	`getGroup()`
`InstanceMetaData`	`getInstanceMetaData()`
`<V> V`	`getLocalAttribute(String attribute)`
`String`	`getScope()`
`String`	`getStringAttribute(String id)`
`String`	`getSubIpGroups()`
`String`	`getSubscriberName()` 获取登记表中的订阅者名称
`String`	`getTenant()`
`int`	`hashCode()`
`boolean`	`isCacheable()`
`void`	`setAttribute(String attribute, Serializable value)`
`void`	`setCacheable(boolean cacheable)` 设置此订阅者的数据是否启用本地缓存机制。
`void`	`setGroup(String group)` 设置组别配置数据的订阅者和发布者可以被划分为多个组，订阅者只能收到位于同一组中的发布者所发布的数据。
`void`	`setInstanceMetaData(InstanceMetaData instanceMetaData)`
`void`	`setLocalAttribute(String attribute, Object value)`
`void`	`setScope(ConfigClientConstants.SCOPE scope)` 设置作用域配置数据的订阅者和发布者可以被设置作用域，默认会有全局范围内、单元范围内、机房范围内。
`void`	`setSubIpGroupList(List<String> ipGroupList)` 订阅多个环境分组数据用逗号分隔环境，比如"envG1,envG2,envG3"
`void`	`setTenant(String tenant)` 设置租户以不同租户下面，服务不可见，未设置租户的，到服务端，默认全部归属为XXX租户
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - SubscriberRegistration
```
public SubscriberRegistration(String subscriberName,
                              String dataId)
```
    填写一份新的订阅者登记表
    
    参数:
    
    subscriberName - 订阅者的名称，用于在管理中识别订阅者。建议使用完整的类名（加上可选的后缀以区分不同实例）。
    订阅者名称是一个身份标识，只用于鉴权、统计、管理员维护等管理事物中，对功能没有影响，不要求唯一性。但为了管理的方便，请尽可能的保持其唯一性。
    
    dataId - 所需订阅数据的唯一标识，订阅者通过此标识获取采用相同标识的发布者所发布的数据。
  - SubscriberRegistration
```
public SubscriberRegistration(String subscriberName,
                              String dataId,
                              String datumId)
```
- 方法详细资料
  - setCacheable
```
public void setCacheable(boolean cacheable)
```
    设置此订阅者的数据是否启用本地缓存机制。
    启动本地缓存机制将产生两个直接效果：
    - 在获得服务端数据前将首先加载此前缓存的数据（如果可用），订阅者会首先收到缓存的数据。
    - 在数据更新后同步保存至缓存中，供其他订阅者或程序重启后使用。
    关闭本地缓存机制的效果：
    - 订阅者获得的数据（包括第一次收到的数据）一定是从服务端得到的，因此通常可以认为是最新的数据。
    - 当无法从服务端获得数据时（如服务端异常、通信异常），订阅者将不能收到任何数据。
    九任更改：强制缓存所有配置（包括持久数据）。防止由于CS不存在导致应用无法启动的情况。
    参数:
    
    cacheable - 是否启用本地缓存机制，默认为启用。
    
    从以下版本开始:
    
    1.3
  - isCacheable
```
public boolean isCacheable()
```
  - setSubIpGroupList
```
public void setSubIpGroupList(List<String> ipGroupList)
```
    订阅多个环境分组数据用逗号分隔环境，比如"envG1,envG2,envG3"
    
    参数:
    
    ipGroupList - 同步范围 envGroups 不能为空
  - getSubIpGroups
```
public String getSubIpGroups()
```
  - getSubscriberName
```
public String getSubscriberName()
```
    获取登记表中的订阅者名称
    
    返回:
    
    登记表中最初填写的订阅者名称
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getDataId
```
public String getDataId()
```
  - getDatumId
```
public String getDatumId()
```
  - setGroup
```
public void setGroup(String group)
```
    设置组别
    配置数据的订阅者和发布者可以被划分为多个组，订阅者只能收到位于同一组中的发布者所发布的数据。未设置组别的发布者和订阅者将被分入一个全局唯一的默认组中，这个组与其它任何显式指定的组均彼此隔离。
    
    参数:
    
    group - 组名
  - getGroup
```
public String getGroup()
```
  - setScope
```
public void setScope(ConfigClientConstants.SCOPE scope)
```
    设置作用域
    配置数据的订阅者和发布者可以被设置作用域，默认会有全局范围内、单元范围内、机房范围内。默认为全局作用域，发布的数据只能被作用域内感知到。 ConfigClientConstants 选项
    
    参数:
    
    scope - 同步范围
  - getScope
```
public String getScope()
```
  - getInstanceMetaData
```
public InstanceMetaData getInstanceMetaData()
```
  - setInstanceMetaData
```
public void setInstanceMetaData(InstanceMetaData instanceMetaData)
```
  - setTenant
```
public void setTenant(String tenant)
```
    设置租户
    以不同租户下面，服务不可见，未设置租户的，到服务端，默认全部归属为XXX租户
    
    参数:
    
    tenant -
  - getTenant
```
public String getTenant()
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(Object obj)
```
  - setAttribute
```
public void setAttribute(String attribute,
                         Serializable value)
```
  - getAttribute
```
public <V extends Serializable> V getAttribute(String attribute)
```
  - getStringAttribute
```
public String getStringAttribute(String id)
```
  - getAllAttributes
```
public Set<Map.Entry<String,Serializable>> getAllAttributes()
```
  - setLocalAttribute
```
public void setLocalAttribute(String attribute,
                              Object value)
```
  - getLocalAttribute
```
public <V> V getLocalAttribute(String attribute)
```
  - getClientName
```
protected String getClientName()
```
  - getClientId
```
protected String getClientId()
```

类 SubscriberRegistration

构造器概要

方法概要

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

构造器详细资料

SubscriberRegistration

SubscriberRegistration

方法详细资料

setCacheable

isCacheable

setSubIpGroupList

getSubIpGroups

getSubscriberName

toString

getDataId

getDatumId

setGroup

getGroup

setScope

getScope

getInstanceMetaData

setInstanceMetaData

setTenant

getTenant

hashCode

equals

setAttribute

getAttribute

getStringAttribute

getAllAttributes

setLocalAttribute

getLocalAttribute

getClientName

getClientId