ClientExtendTools (facelog client base Microsoft/thrifty 3.1.2 API)

java.lang.Object
- net.gdface.facelog.client.ClientExtendTools

public class ClientExtendTools
extends java.lang.Object

client端便利性扩展工具类

作者:: guyadong

嵌套类概要

嵌套类
限定符和类型类和说明

static interface ClientExtendTools.ParameterSupplier<T>

嵌套类
限定符和类型	类和说明
`static interface`	`ClientExtendTools.ParameterSupplier<T>`

字段概要

字段
限定符和类型	字段和说明
`com.google.common.base.Predicate<java.lang.String>`	`ackChannelValidator` 设备命令响应通道验证器
`com.google.common.base.Predicate<java.lang.Integer>`	`cmdSnValidator` 设备命令序列号验证器
`com.google.common.base.Function<java.lang.Integer,java.lang.Integer>`	`deviceGroupIdGetter` 根据设备ID返回设备所属的设备组ID的`Function`实例, 设备ID无效则返回`null`
`com.google.common.base.Predicate<Token>`	`deviceTokenValidator` 设备令牌验证器
`com.google.common.base.Function<java.lang.Integer,java.util.List<java.lang.Integer>>`	`personGroupBelonsGetter` 根据人员ID返回人员所属的所有组ID的`Function`实例如果人员ID无效则返回空表
`com.google.common.base.Predicate<Token>`	`personTokenValidator` 人员令牌验证器
`com.google.common.base.Predicate<Token>`	`rootTokenValidator` root令牌验证器
`com.google.common.base.Function<Token,java.lang.Integer>`	`tokenRank` 返回令牌的管理等级,输入为`null`或设备令牌返回-1 4---root 3---管理员 2---操作员 0---普通用户 -1---未定义

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ClientExtendTools`	`addServiceEventListener(ServiceHeartbeatListener listener)`
`com.google.common.base.Supplier<java.lang.String>`	`getAckChannelSupplier(int duration, Token token)` 返回一个申请命令响应通道的`Supplier`实例
`com.google.common.base.Supplier<java.lang.String>`	`getAckChannelSupplier(Token token)` 返回一个申请命令响应通道的`Supplier`实例
`com.google.common.base.Supplier<java.lang.String>`	`getCmdChannelSupplier(Token token)` 返回一个获取设备命令通道名的`Supplier`实例
`com.google.common.base.Supplier<java.lang.Integer>`	`getCmdSnSupplier(Token token)` 返回一个申请命令序号的`Supplier`实例
`com.google.common.base.Supplier<java.lang.Integer>`	`getDeviceGroupIdSupplier(int deviceId)` 根据设备ID返回一个获取设备组ID的`Supplier`实例
`com.google.common.base.Supplier<java.lang.String>`	`getDynamicParamSupplier(MQParam mqParam, Token token)`
`com.google.common.base.Supplier<java.util.Map<java.lang.String,java.lang.String>>`	`getFaceApiParametersSupplier(Token token)`
`net.gdface.thrift.ClientFactory`	`getFactory()`
`com.google.common.base.Supplier<java.util.Map<MQParam,java.lang.String>>`	`getMessageQueueParametersSupplier(Token token)`
`com.google.common.base.Supplier<java.util.List<java.lang.Integer>>`	`getPersonGroupBelonsSupplier(int personId)` 根据人员ID返回一个获取所属组ID列表的`Supplier`实例
`com.google.common.base.Supplier<java.util.Map<MQParam,java.lang.String>>`	`getRedisParametersSupplier(Token token)`
`ClientExtendTools.ParameterSupplier<java.lang.String>`	`getSdkTaskQueueSupplier(java.lang.String task, java.lang.String sdkVersion, Token token)`
`ClientExtendTools.ParameterSupplier<java.lang.String>`	`getTaskQueueSupplier(java.lang.String task, Token token)`
`com.google.common.base.Supplier<Token>`	`getTokenSupplier()` 返回有效令牌的`Supplier`实例
`DtalkEngineForFacelog`	`initDtalkEngine(Token deviceToken, gu.dtalk.MenuItem rootMenu)` 创建dtalk引擎
`void`	`initMQDefaultFactory(Token token)` 从facelog获取消息系统参数，初始化消息系统的默认实例该方法只能在应用启动时调用一次
`com.google.common.net.HostAndPort`	`insteadHostIfLocalhost(com.google.common.net.HostAndPort host)` 如果`host`是本机地址则用facelog服务主机名替换
`java.lang.String`	`insteadHostIfLocalhost(java.lang.String host)` 如果`host`是本机地址则用facelog服务主机名替换
`java.net.URI`	`insteadHostIfLocalhost(java.net.URI uri)` 如果`uri`的主机名是本机地址则用facelog服务主机名替换
`java.net.URL`	`insteadHostIfLocalhost(java.net.URL url)` 如果`url`的主机名是本机地址则用facelog服务主机名替换
`java.lang.String`	`insteadHostJsonIfLocalhost(java.lang.String json)` 如果`json`中的值为URI,且主机名是本机地址则用facelog服务主机名替换
`java.util.Map<MQParam,java.lang.String>`	`insteadHostOfMQParamIfLocalhost(java.util.Map<MQParam,java.lang.String> parameters)` 如果`parameters`的参数(`MQParam.REDIS_URI`,`MQParam.WEBREDIS_URL`, 或`MQParam.MQ_CONNECT` (JSON)中的值)是本机地址则用facelog服务主机名替换
`java.lang.String`	`insteadHostOfURIIfLocalhost(java.lang.String uri)` 如果`uri`的主机名是本机地址则用facelog服务主机名替换
`java.lang.String`	`insteadHostOfURLIfLocalhost(java.lang.String url)` 如果`url`的主机名是本机地址则用facelog服务主机名替换
`java.util.Map<java.lang.String,java.lang.String>`	`insteadHostOfValueIfLocalhost(java.util.Map<java.lang.String,java.lang.String> parameters)` 如果`parameters`的值(host:port格式)是本机地址则用facelog服务主机名替换
`gu.dtalk.engine.CmdDispatcher`	`makeCmdDispatcher(Token token)` (设备端)创建设备多目标命令分发器
`gu.dtalk.cmd.CmdManager`	`makeCmdManager(Token token)` (管理端)创建`CmdManager`实例
`<T> DynamicChannelListener<T>`	`makeDynamicChannelListener(gu.simplemq.IMessageAdapter<T> listener, java.lang.Class<T> channelType, MQParam mqParam, Token token, gu.simplemq.IMessageQueueFactory factory)` 创建动态频道名侦听对象动态频道是指定当服务重启后，频道名会动态改变的频道，对于这种频道，通过侦听服务心跳判断服务是否重启，如果重启则重新获取频道名继续保持侦听
`DeviceHeartbeat`	`makeHeartbeat(int deviceID, Token token)` 创建设备心跳包发送对象 `DeviceHeartbeat`为单实例,该方法只能调用一次
`gu.dtalk.engine.TaskDispatcher`	`makeTaskDispatcher(Token token, com.google.common.base.Supplier<java.lang.String> taskQueueSupplier)` (设备端)创建设备任务分发器
`gu.dtalk.cmd.TaskManager`	`makeTaskManager(Token token, java.lang.String cmdpath, com.google.common.base.Supplier<java.lang.String> taskQueueSupplier)` (管理端)创建`TaskManager`实例
`Token`	`refreshToken(TokenHelper helper, Token token)` 令牌刷新
`ClientExtendTools`	`removeServiceEventListener(ServiceHeartbeatListener listener)`
`ClientExtendTools`	`setTokenHelper(TokenHelper tokenHelper)`
`ClientExtendTools`	`startServiceHeartbeatListener(Token token, boolean initMQDefaultFactoryInstance)` 启动服务心跳侦听器启动侦听器后CLIENT端才能感知服务端断线，并执行相应动作。

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

字段详细资料

deviceGroupIdGetter
```
public final com.google.common.base.Function<java.lang.Integer,java.lang.Integer> deviceGroupIdGetter
```
根据设备ID返回设备所属的设备组ID的Function实例, 设备ID无效则返回null

personGroupBelonsGetter

public final com.google.common.base.Function<java.lang.Integer,java.util.List<java.lang.Integer>> personGroupBelonsGetter

根据人员ID返回人员所属的所有组ID的Function实例如果人员ID无效则返回空表

cmdSnValidator

public final com.google.common.base.Predicate<java.lang.Integer> cmdSnValidator

设备命令序列号验证器

ackChannelValidator

public final com.google.common.base.Predicate<java.lang.String> ackChannelValidator

设备命令响应通道验证器

deviceTokenValidator

public final com.google.common.base.Predicate<Token> deviceTokenValidator

设备令牌验证器

personTokenValidator

public final com.google.common.base.Predicate<Token> personTokenValidator

人员令牌验证器

rootTokenValidator

public final com.google.common.base.Predicate<Token> rootTokenValidator

root令牌验证器

tokenRank

public final com.google.common.base.Function<Token,java.lang.Integer> tokenRank

返回令牌的管理等级,输入为null或设备令牌返回-1

4---root
3---管理员
2---操作员
0---普通用户
-1---未定义

方法详细资料
- insteadHostIfLocalhost
```
public java.lang.String insteadHostIfLocalhost(java.lang.String host)
```
  如果host是本机地址则用facelog服务主机名替换
  
  参数:
  
  host -
  
  返回:
  
  host or host in factory
- insteadHostIfLocalhost
```
public com.google.common.net.HostAndPort insteadHostIfLocalhost(com.google.common.net.HostAndPort host)
```
  如果host是本机地址则用facelog服务主机名替换
  
  参数:
  
  host -
  
  返回:
  
  host or host in factory
- insteadHostIfLocalhost
```
public java.net.URI insteadHostIfLocalhost(java.net.URI uri)
```
  如果uri的主机名是本机地址则用facelog服务主机名替换
  
  参数:
  
  uri -
  
  返回:
  
  uri or new URI instead with host of facelog
- insteadHostIfLocalhost
```
public java.net.URL insteadHostIfLocalhost(java.net.URL url)
```
  如果url的主机名是本机地址则用facelog服务主机名替换
  
  参数:
  
  url -
  
  返回:
  
  url or new URI instead with host of facelog
- insteadHostJsonIfLocalhost
```
public java.lang.String insteadHostJsonIfLocalhost(java.lang.String json)
```
  如果json中的值为URI,且主机名是本机地址则用facelog服务主机名替换
  
  参数:
  
  json -
  
  返回:
  
  json or new json string instead with host of facelog
- insteadHostOfURIIfLocalhost
```
public java.lang.String insteadHostOfURIIfLocalhost(java.lang.String uri)
```
  如果uri的主机名是本机地址则用facelog服务主机名替换
  
  参数:
  
  uri -
  
  返回:
  
  uri or new URI string instead with host of facelog
- insteadHostOfURLIfLocalhost
```
public java.lang.String insteadHostOfURLIfLocalhost(java.lang.String url)
```
  如果url的主机名是本机地址则用facelog服务主机名替换
  
  参数:
  
  url -
  
  返回:
  
  url or new URL string instead with host of facelog
- insteadHostOfMQParamIfLocalhost
```
public java.util.Map<MQParam,java.lang.String> insteadHostOfMQParamIfLocalhost(java.util.Map<MQParam,java.lang.String> parameters)
```
  如果parameters的参数(MQParam.REDIS_URI,MQParam.WEBREDIS_URL, 或MQParam.MQ_CONNECT (JSON)中的值)是本机地址则用facelog服务主机名替换
  
  参数:
  
  parameters -
  
  返回:
  
  替换主机名参数后的新对象 HashMap
- insteadHostOfValueIfLocalhost
```
public java.util.Map<java.lang.String,java.lang.String> insteadHostOfValueIfLocalhost(java.util.Map<java.lang.String,java.lang.String> parameters)
```
  如果parameters的值(host:port格式)是本机地址则用facelog服务主机名替换
  
  参数:
  
  parameters -
  
  返回:
  
  替换主机名参数后的新对象 HashMap
  
  另请参阅:
  
  insteadHostIfLocalhost(HostAndPort)
- getDeviceGroupIdSupplier
```
public com.google.common.base.Supplier<java.lang.Integer> getDeviceGroupIdSupplier(int deviceId)
```
  根据设备ID返回一个获取设备组ID的Supplier实例
  
  参数:
  
  deviceId -
  
  返回:
  
  对应的groupId,如果deviceId无效则返回null
  
  另请参阅:
  
  deviceGroupIdGetter
- getPersonGroupBelonsSupplier
```
public com.google.common.base.Supplier<java.util.List<java.lang.Integer>> getPersonGroupBelonsSupplier(int personId)
```
  根据人员ID返回一个获取所属组ID列表的Supplier实例
  
  参数:
  
  personId -
  
  返回:
  
  人员组ID列表,如果personId无效则返回空表
  
  另请参阅:
  
  personGroupBelonsGetter
- makeCmdManager
```
public gu.dtalk.cmd.CmdManager makeCmdManager(Token token)
```
  (管理端)创建CmdManager实例
  
  参数:
  
  token - 访问令牌(person Token or root Token)
  
  返回:
  
  CmdManager实例
- makeTaskManager
```
public gu.dtalk.cmd.TaskManager makeTaskManager(Token token,
                                                java.lang.String cmdpath,
                                                com.google.common.base.Supplier<java.lang.String> taskQueueSupplier)
```
  (管理端)创建TaskManager实例
  
  参数:
  
  token - 访问令牌(person Token or root Token)
  
  cmdpath - 设备(菜单)命令路径
  
  taskQueueSupplier - 任务队列
  
  返回:
  
  TaskManager实例
- makeCmdDispatcher
```
public gu.dtalk.engine.CmdDispatcher makeCmdDispatcher(Token token)
```
  (设备端)创建设备多目标命令分发器
  
  参数:
  
  token - 设备令牌
  
  返回:
  
  CmdDispatcher实例
- makeTaskDispatcher
```
public gu.dtalk.engine.TaskDispatcher makeTaskDispatcher(Token token,
                                                         com.google.common.base.Supplier<java.lang.String> taskQueueSupplier)
```
  (设备端)创建设备任务分发器
  
  参数:
  
  token - 设备令牌
  
  taskQueueSupplier - 任务队列名,创建的分发器对象注册到任务队列，可为null
  
  返回:
  
  TaskDispatcher实例
- getAckChannelSupplier
```
public com.google.common.base.Supplier<java.lang.String> getAckChannelSupplier(int duration,
                                                                               Token token)
```
  返回一个申请命令响应通道的Supplier实例
  
  参数:
  
  duration - 命令通道有效时间(秒) 大于0有效,否则使用默认的有效期
  
  token - 访问令牌
  
  返回:
  
  Supplier实例
- getAckChannelSupplier
```
public com.google.common.base.Supplier<java.lang.String> getAckChannelSupplier(Token token)
```
  返回一个申请命令响应通道的Supplier实例
  
  参数:
  
  token - 访问令牌
  
  返回:
  
  Supplier实例
- getCmdSnSupplier
```
public com.google.common.base.Supplier<java.lang.Integer> getCmdSnSupplier(Token token)
```
  返回一个申请命令序号的Supplier实例
  
  参数:
  
  token -
  
  返回:
  
  Supplier实例
- getCmdChannelSupplier
```
public com.google.common.base.Supplier<java.lang.String> getCmdChannelSupplier(Token token)
```
  返回一个获取设备命令通道名的Supplier实例
  
  参数:
  
  token -
  
  返回:
  
  Supplier实例
- getRedisParametersSupplier
```
public com.google.common.base.Supplier<java.util.Map<MQParam,java.lang.String>> getRedisParametersSupplier(Token token)
```
  参数:
  
  token - 调用 getRedisParametersLazy(Token)所需要的令牌
  
  返回:
  
  返回一个获取redis参数的Supplier实例
- getMessageQueueParametersSupplier
```
public com.google.common.base.Supplier<java.util.Map<MQParam,java.lang.String>> getMessageQueueParametersSupplier(Token token)
```
  参数:
  
  token - 调用 getMessageQueueParametersLazy(Token)所需要的令牌
  
  返回:
  
  返回一个获取消息系统参数的Supplier实例
- getFaceApiParametersSupplier
```
public com.google.common.base.Supplier<java.util.Map<java.lang.String,java.lang.String>> getFaceApiParametersSupplier(Token token)
```
  参数:
  
  token - 调用 getFaceApiParametersLazy(Token)所需要的令牌
  
  返回:
  
  返回一个获取redis参数的Supplier实例
- getDynamicParamSupplier
```
public com.google.common.base.Supplier<java.lang.String> getDynamicParamSupplier(MQParam mqParam,
                                                                                 Token token)
```
  参数:
  
  mqParam -
  
  token - 调用 getRedisParametersLazy(Token)所需要的令牌
  
  返回:
  
  返回一个动态获取指定消息参数的Supplier实例
- initDtalkEngine
```
public DtalkEngineForFacelog initDtalkEngine(Token deviceToken,
                                             gu.dtalk.MenuItem rootMenu)
```
  创建dtalk引擎
  
  参数:
  
  deviceToken - 设备令牌，不可为null
  
  rootMenu - 包括所有菜单的根菜单对象，不可为null
  
  返回:
  
  DtalkEngineForFacelog实例
- initMQDefaultFactory
```
public void initMQDefaultFactory(Token token)
```
  从facelog获取消息系统参数，初始化消息系统的默认实例
  该方法只能在应用启动时调用一次
  
  参数:
  
  token -
- refreshToken
```
public Token refreshToken(TokenHelper helper,
                          Token token)
```
  令牌刷新
  
  参数:
  
  helper -
  
  token -
  
  返回:
  
  刷新的令牌,刷新失败返回null
- getTokenSupplier
```
public com.google.common.base.Supplier<Token> getTokenSupplier()
```
  返回有效令牌的Supplier实例
  
  返回:
  
  Supplier实例
- addServiceEventListener
```
public ClientExtendTools addServiceEventListener(ServiceHeartbeatListener listener)
```
- removeServiceEventListener
```
public ClientExtendTools removeServiceEventListener(ServiceHeartbeatListener listener)
```
- makeDynamicChannelListener
```
public <T> DynamicChannelListener<T> makeDynamicChannelListener(gu.simplemq.IMessageAdapter<T> listener,
                                                                java.lang.Class<T> channelType,
                                                                MQParam mqParam,
                                                                Token token,
                                                                gu.simplemq.IMessageQueueFactory factory)
```
  创建动态频道名侦听对象动态频道是指定当服务重启后，频道名会动态改变的频道，对于这种频道，通过侦听服务心跳判断服务是否重启，如果重启则重新获取频道名继续保持侦听
  
  参数:
  
  listener -
  
  channelType - 频道消息数据类型
  
  mqParam - 参数名
  
  token -
  
  factory - 消息系统工厂类实例
  
  返回:
  
  返回DynamicChannelListener实例
- makeHeartbeat
```
public DeviceHeartbeat makeHeartbeat(int deviceID,
                                     Token token)
```
  创建设备心跳包发送对象
  DeviceHeartbeat为单实例,该方法只能调用一次
  
  参数:
  
  deviceID - 设备ID
  
  token - 设备令牌
  
  返回:
  
  DeviceHeartbeat实例
- setTokenHelper
```
public ClientExtendTools setTokenHelper(TokenHelper tokenHelper)
```
  参数:
  
  tokenHelper - 要设置的 tokenHelper
  
  返回:
  
  当前ClientExtendTools实例
- startServiceHeartbeatListener
```
public ClientExtendTools startServiceHeartbeatListener(Token token,
                                                       boolean initMQDefaultFactoryInstance)
```
  启动服务心跳侦听器
  启动侦听器后CLIENT端才能感知服务端断线，并执行相应动作。调用前必须先执行setTokenHelper(TokenHelper)初始化
  
  参数:
  
  token - 令牌
  
  initMQDefaultFactoryInstance - 是否初始化 IMessageQueueFactory默认实例
  
  返回:
  
  返回当前ClientExtendTools实例
- getTaskQueueSupplier
```
public ClientExtendTools.ParameterSupplier<java.lang.String> getTaskQueueSupplier(java.lang.String task,
                                                                                  Token token)
```
- getSdkTaskQueueSupplier
```
public ClientExtendTools.ParameterSupplier<java.lang.String> getSdkTaskQueueSupplier(java.lang.String task,
                                                                                     java.lang.String sdkVersion,
                                                                                     Token token)
```
- getFactory
```
public net.gdface.thrift.ClientFactory getFactory()
```

类 ClientExtendTools

嵌套类概要

字段概要

方法概要

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

字段详细资料

deviceGroupIdGetter

personGroupBelonsGetter

cmdSnValidator

ackChannelValidator

deviceTokenValidator

personTokenValidator

rootTokenValidator

tokenRank

方法详细资料

insteadHostIfLocalhost

insteadHostIfLocalhost

insteadHostIfLocalhost

insteadHostIfLocalhost

insteadHostJsonIfLocalhost

insteadHostOfURIIfLocalhost

insteadHostOfURLIfLocalhost

insteadHostOfMQParamIfLocalhost

insteadHostOfValueIfLocalhost

getDeviceGroupIdSupplier

getPersonGroupBelonsSupplier

makeCmdManager

makeTaskManager

makeCmdDispatcher

makeTaskDispatcher

getAckChannelSupplier

getAckChannelSupplier

getCmdSnSupplier

getCmdChannelSupplier

getRedisParametersSupplier

getMessageQueueParametersSupplier

getFaceApiParametersSupplier

getDynamicParamSupplier

initDtalkEngine

initMQDefaultFactory

refreshToken

getTokenSupplier

addServiceEventListener

removeServiceEventListener

makeDynamicChannelListener

makeHeartbeat

setTokenHelper

startServiceHeartbeatListener

getTaskQueueSupplier

getSdkTaskQueueSupplier

getFactory