Skip to content

class Secret

cangjie
public class Secret <: Serializable<Secret>

功能:表示客户端或资源使用的密钥信息。

父类型:

成员概览

成员功能
init()创建空的密钥实例。
init(String, ?DateTime, ?String)使用值和可选元数据创建密钥。
var value保存密钥值。
var enabled标识密钥是否启用。
var expiration保存密钥过期时间。
var description保存密钥描述信息。
func serialize()将当前密钥序列化为数据模型。
func deserialize(DataModel)从数据模型反序列化密钥。

init()

cangjie
public init()

功能:创建空的密钥实例。

init(String, ?DateTime, ?String)

cangjie
public init(value: String, expiration!: ?DateTime = None, description!: ?String = None)

功能:使用值和可选元数据创建密钥。

参数:

  • value: String - 密钥值。
  • expiration: ?DateTime - 密钥过期时间。
  • description: ?String - 密钥描述信息。

var value

cangjie
public var value: String = String.empty

功能:保存密钥值。

类型:String

var enabled

cangjie
public var enabled: Bool = true

功能:标识密钥是否启用。

类型:Bool

var expiration

cangjie
public var expiration: ?DateTime = None

功能:保存密钥过期时间。

类型:?DateTime

var description

cangjie
public var description: ?String = None

功能:保存密钥描述信息。

类型:?String

func serialize()

cangjie
public func serialize(): DataModelStruct

功能:将当前密钥序列化为数据模型。

返回值:

  • DataModelStruct - 返回密钥对应的数据模型结构。

func deserialize(DataModel)

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

功能:从数据模型反序列化密钥。

参数:

  • dm: DataModel - 密钥对应的数据模型。

返回值:

  • Secret - 返回反序列化后的密钥。

异常:

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