Spire 天擎

外观

class AuthenticationProperties ​

cangjie
public class AuthenticationProperties <: Serializable<AuthenticationProperties>

功能：保存身份验证流程中的附加属性。

父类型：

成员概览 ​

成员功能
init(HashMap<String, String>)使用已有属性字典创建身份验证属性。
init()创建一个空的身份验证属性集合。
prop items返回底层属性字典。
prop redirectUri获取或设置重定向地址。
prop isPersistent获取或设置是否持久化登录状态。
prop allowRefresh获取或设置是否允许刷新。
prop issuedUtc获取或设置票据签发时间。
prop expiresUtc获取或设置票据过期时间。
func serialize()将当前身份验证属性序列化为数据模型。
func deserialize(DataModel)从数据模型反序列化身份验证属性。

init(HashMap<String, String>) ​

cangjie
public init(items: HashMap<String, String>)

功能：使用已有属性字典创建身份验证属性。

参数：

  • items: HashMap<String, String> - 属性字典。

init() ​

cangjie
public init()

功能：创建一个空的身份验证属性集合。

prop items ​

cangjie
public prop items: HashMap<String, String>

功能：返回底层属性字典。

类型：HashMap<String, String>

prop redirectUri ​

cangjie
public mut prop redirectUri: ?String

功能：获取或设置重定向地址。

类型：?String

prop isPersistent ​

cangjie
public mut prop isPersistent: Bool

功能：获取或设置是否持久化登录状态。

类型：Bool

prop allowRefresh ​

cangjie
public mut prop allowRefresh: ?Bool

功能：获取或设置是否允许刷新。

类型：?Bool

prop issuedUtc ​

cangjie
public mut prop issuedUtc: ?DateTime

功能：获取或设置票据签发时间。

类型：?DateTime

prop expiresUtc ​

cangjie
public mut prop expiresUtc: ?DateTime

功能：获取或设置票据过期时间。

类型：?DateTime

func serialize() ​

cangjie
public func serialize(): DataModelStruct

功能：将当前身份验证属性序列化为数据模型。

返回值：

  • DataModelStruct - 序列化后的数据模型。

func deserialize(DataModel) ​

cangjie
public static func deserialize(dm: DataModel): AuthenticationProperties

功能：从数据模型反序列化身份验证属性。

参数：

  • dm: DataModel - 输入的数据模型。

返回值：

异常：

  • DataModelException - 当输入数据不是对象结构时抛出。

扩展成员 ​

成员功能
func storeTokens(Array<AuthenticationToken>)批量存储身份验证令牌。
func updateTokenValue(String, String)更新指定令牌的值。
func getTokens()返回当前已存储的令牌集合。
func getTokenValue(String)返回指定名称的令牌值。

func storeTokens(Array<AuthenticationToken>) ​

cangjie
public func storeTokens(tokens: Array<AuthenticationToken>): Unit

功能：批量存储身份验证令牌。

参数：

返回值：

  • Unit

异常：

  • IllegalArgumentException - 当令牌名称为空或包含非法分隔符时抛出。

func updateTokenValue(String, String) ​

cangjie
public func updateTokenValue(tokenName: String, tokenValue: String): Bool

功能：更新指定令牌的值。

参数：

  • tokenName: String - 令牌名称。
  • tokenValue: String - 新的令牌值。

返回值：

  • Bool - 更新成功时返回 true；令牌不存在时返回 false。

func getTokens() ​

cangjie
public func getTokens(): Collection<AuthenticationToken>

功能：返回当前已存储的令牌集合。

返回值：

func getTokenValue(String) ​

cangjie
public func getTokenValue(tokenName: String): ?String

功能：返回指定名称的令牌值。

参数：

  • tokenName: String - 令牌名称。

返回值：

  • ?String - 令牌值；不存在时返回 None。