Spire 天擎

外观

class ClaimsIdentity ​

cangjie
public class ClaimsIdentity <: Serializable<ClaimsIdentity>

功能：表示一组声明及其认证信息。

父类型：

成员概览 ​

成员功能
init()创建空的声明标识。
init(Collection<Claim>)使用指定声明集合创建声明标识。
init(?String)使用认证类型创建空声明标识。
init(?String, Collection<Claim>)使用认证类型和声明集合创建声明标识。
prop claims返回当前标识包含的声明集合。
prop isAuthenticated返回当前标识是否已通过认证。
prop authenticationType返回当前标识的认证类型。
func addClaim(Claim)添加一条声明。
func addClaim(String, String)添加一条字符串值类型声明。
func addClaim(String, String, String)添加一条指定值类型声明。
func addClaims(Collection<Claim>)批量添加声明。
func findAll((Claim) -> Bool)查找满足条件的全部声明。
func findAll(String)按声明类型查找全部声明。
func findFirst((Claim) -> Bool)查找首个满足条件的声明。
func findFirst(String)按声明类型查找首条声明。
func findFirstValue((Claim) -> Bool)查找首个满足条件声明的值。
func findFirstValue(String)按声明类型查找首个声明值。
func hasClaim((Claim) -> Bool)检查是否存在满足条件的声明。
func hasClaim(String, String)检查是否存在指定类型和值的声明。
func serialize()将当前声明标识序列化为数据模型。
func deserialize(DataModel)从数据模型反序列化声明标识。
func clone()克隆当前声明标识。

init() ​

cangjie
public init()

功能：创建空的声明标识。

init(Collection<Claim>) ​

cangjie
public init(claims: Collection<Claim>)

功能：使用指定声明集合创建声明标识。

参数：

  • claims: Collection<Claim> - 初始声明集合。

init(?String) ​

cangjie
public init(authenticationType: ?String)

功能：使用认证类型创建空声明标识。

参数：

  • authenticationType: ?String - 认证类型。

init(?String, Collection<Claim>) ​

cangjie
public init(authenticationType: ?String, claims: Collection<Claim>)

功能：使用认证类型和声明集合创建声明标识。

参数：

  • authenticationType: ?String - 认证类型。
  • claims: Collection<Claim> - 初始声明集合。

prop claims ​

cangjie
public prop claims: Collection<Claim>

功能：返回当前标识包含的声明集合。

类型：Collection<Claim>

prop isAuthenticated ​

cangjie
public prop isAuthenticated: Bool

功能：返回当前标识是否已通过认证。

类型：Bool

prop authenticationType ​

cangjie
public prop authenticationType: ?String

功能：返回当前标识的认证类型。

类型：?String

func addClaim(Claim) ​

cangjie
public func addClaim(claim: Claim): Unit

功能：添加一条声明。

参数：

  • claim: Claim - 需要添加的声明。

返回值：

  • Unit

func addClaim(String, String) ​

cangjie
public func addClaim(`type`: String, value: String): Unit

功能：添加一条字符串值类型声明。

参数：

  • type: String
  • value: String - 声明值。

返回值：

  • Unit

func addClaim(String, String, String) ​

cangjie
public func addClaim(`type`: String, value: String, valueType: String): Unit

功能：添加一条指定值类型声明。

参数：

  • type: String
  • value: String - 声明值。
  • valueType: String - 声明值类型。

返回值：

  • Unit

func addClaims(Collection<Claim>) ​

cangjie
public func addClaims(claims: Collection<Claim>): Unit

功能：批量添加声明。

参数：

  • claims: Collection<Claim> - 需要添加的声明集合。

返回值：

  • Unit

func findAll((Claim) -> Bool) ​

cangjie
public func findAll(predicate: (Claim) -> Bool): Array<Claim>

功能：查找满足条件的全部声明。

参数：

  • predicate: (Claim) -> Bool - 声明筛选条件。

返回值：

  • Array<Claim> - 返回匹配的声明数组。

func findAll(String) ​

cangjie
public func findAll(`type`: String): Array<Claim>

功能：按声明类型查找全部声明。

参数：

  • type: String

返回值：

  • Array<Claim> - 返回匹配的声明数组。

func findFirst((Claim) -> Bool) ​

cangjie
public func findFirst(predicate: (Claim) -> Bool): ?Claim

功能：查找首个满足条件的声明。

参数：

  • predicate: (Claim) -> Bool - 声明筛选条件。

返回值：

  • ?Claim - 返回首个匹配的声明；不存在时返回空。

func findFirst(String) ​

cangjie
public func findFirst(`type`: String): ?Claim

功能：按声明类型查找首条声明。

参数：

  • type: String

返回值：

  • ?Claim - 返回首个匹配的声明；不存在时返回空。

func findFirstValue((Claim) -> Bool) ​

cangjie
public func findFirstValue(predicate: (Claim) -> Bool): ?String

功能：查找首个满足条件声明的值。

参数：

  • predicate: (Claim) -> Bool - 声明筛选条件。

返回值：

  • ?String - 返回首个匹配声明的值；不存在时返回空。

func findFirstValue(String) ​

cangjie
public func findFirstValue(`type`: String): ?String

功能：按声明类型查找首个声明值。

参数：

  • type: String

返回值：

  • ?String - 返回首个匹配声明的值；不存在时返回空。

func hasClaim((Claim) -> Bool) ​

cangjie
public func hasClaim(predicate: (Claim) -> Bool): Bool

功能：检查是否存在满足条件的声明。

参数：

  • predicate: (Claim) -> Bool - 声明筛选条件。

返回值：

  • Bool - 如果存在匹配声明则返回 true。

func hasClaim(String, String) ​

cangjie
public func hasClaim(`type`: String, value: String): Bool

功能：检查是否存在指定类型和值的声明。

参数：

  • type: String
  • value: String - 声明值。

返回值：

  • Bool - 如果存在匹配声明则返回 true。

func serialize() ​

cangjie
public func serialize(): DataModelStruct

功能：将当前声明标识序列化为数据模型。

返回值：

  • DataModelStruct - 返回声明标识对应的数据模型结构。

func deserialize(DataModel) ​

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

功能：从数据模型反序列化声明标识。

参数：

  • dm: DataModel - 声明标识对应的数据模型。

返回值：

异常：

  • DataModelException - 当数据模型不是结构类型时抛出。

func clone() ​

cangjie
public func clone(): ClaimsIdentity

功能：克隆当前声明标识。

返回值：