AuthService

AuthService

授权服务。 管理引擎的授权信息。

Constructor

new AuthService()

构造函数。

Extends

Classes

AuthService

Members

(protected) defaultRetrospect :number

Overrides:

默认回溯时长,默认值:30个自然天。

Type:
  • number

(protected) dependencies :Array.<string>

Overrides:

模块的外部依赖。

Type:
  • Array.<string>

(protected) deps :Array.<string>

Overrides:

依赖库列表。

Type:
  • Array.<string>

DOMAIN :string

域。

Type:
  • string

(protected) kernel :Kernel

Overrides:

内核对象。

Type:

NAME :string

模块名。

Type:
  • string

(protected) name :string

Overrides:

模块名称。

Type:
  • string

(protected) pipeline :Pipeline

Overrides:

模块使用的默认数据管道。

Type:

(protected) pluginSystem :PluginSystem

Overrides:

消息插件系统。

Type:

(protected) started :boolean

Overrides:

是否已启动。

Type:
  • boolean

TOKEN :string

终端持有的有效令牌码。

Type:
  • string

Methods

allocToken(id, handler)

分配令牌。

Parameters:
Name Type Description
id number

指定待分配令牌的 ID 。

handler function

分配处理回调函数。参数:(token:AuthToken) 。

applyToken(domain, appKey) → {Promise}

申请令牌。

Parameters:
Name Type Description
domain string

指定有效的域。

appKey string

指定对应的 App Key 值。

Returns:

返回有效的 AuthToken 令牌,如果发生错误返回 null 值。

Type
Promise

(async) check(domain, appKey, addressopt) → {AuthToken}

校验当前的令牌是否有效。 该方法先从本地获取本地令牌进行校验,如果本地令牌失效或者未找到本地令牌,则尝试从授权服务器获取有效的令牌。

Parameters:
Name Type Attributes Description
domain string

令牌对应的域。

appKey string

令牌指定的 App Key 串。

address string <optional>

授权服务器地址。

Returns:

返回令牌实例。如果无法获取到授权令牌返回 null 值。

Type
AuthToken

checkToken()

从服务器查询令牌进行检测。

cleanToken()

清除所有令牌。

config(config)

Overrides:

配置模块。

Parameters:
Name Type Description
config JSON

配置信息。

getAuthToken() → {AuthToken}

Overrides:

获取访问令牌。

Returns:

返回当前存储的访问令牌,如果没有获得令牌返回 null 值。

Type
AuthToken

getName() → {string}

Overrides:

获取模块名称。

Returns:

返回模块名称。

Type
string

getPluginSystem() → {PluginSystem}

Overrides:

获取插件系统对象实例。

Returns:

返回插件系统对象实例。

Type
PluginSystem

getToken() → {AuthToken}

获取令牌实例。

Returns:

返回令牌实例。

Type
AuthToken

hasStarted() → {boolean}

Overrides:

是否已启动过该模块。

Returns:

如果已启动返回 true ,否则返回 false

Type
boolean

isReady() → {boolean}

Overrides:

模块是否就绪。

Returns:

如果模块就绪返回 true

Type
boolean

on(eventopt, listener)

Overrides:
See:

设置指定事件的监听回调函数。

Parameters:
Name Type Attributes Description
event string <optional>

指定事件名。

listener function

当发生该事件时回调此函数,函数参数参看 ModuleEvent

require(moduleName)

Overrides:

声明该模块依赖的其他模块。

Parameters:
Name Type Description
moduleName string

requireFile(fileOrURL, successCallbackopt, failureCallbackopt)

Overrides:

请求外部依赖库文件。

Parameters:
Name Type Attributes Description
fileOrURL string

文件或者文件的 URL 。

successCallback function <optional>
failureCallback function <optional>

resume()

Overrides:

恢复模块。

start() → {boolean}

Overrides:

启动模块。

Returns:

返回 false 表示模块不再需要执行启动流程。

Type
boolean

stop()

Overrides:

停止模块。

suspend()

Overrides:

挂起模块。