Spire 天擎

外观

class AuthenticationOptions ​

cangjie
public class AuthenticationOptions

功能：表示身份验证系统的全局配置。

成员概览 ​

成员功能
var defaultScheme指定默认身份验证方案名称。
var defaultSignInScheme指定默认登录方案名称。
var defaultSignOutScheme指定默认登出方案名称。
var requireAuthenticatedSignIn指定是否要求登录主体已通过身份验证。
var defaultAuthenticateScheme指定默认 authenticate 方案名称。
var defaultForbidScheme指定默认 forbid 方案名称。
var defaultChallengeScheme指定默认 challenge 方案名称。
prop schemes返回已注册身份验证方案列表。
prop schemeMap返回已注册方案名称集合。
func addScheme(String, (AuthenticationSchemeBuilder) -> Unit)添加一个身份验证方案定义。

var defaultScheme ​

cangjie
public var defaultScheme: ?String = None

功能：指定默认身份验证方案名称。

类型：?String

var defaultSignInScheme ​

cangjie
public var defaultSignInScheme: ?String = None

功能：指定默认登录方案名称。

类型：?String

var defaultSignOutScheme ​

cangjie
public var defaultSignOutScheme: ?String = None

功能：指定默认登出方案名称。

类型：?String

var requireAuthenticatedSignIn ​

cangjie
public var requireAuthenticatedSignIn = true

功能：指定是否要求登录主体已通过身份验证。

var defaultAuthenticateScheme ​

cangjie
public var defaultAuthenticateScheme: ?String = None

功能：指定默认 authenticate 方案名称。

类型：?String

var defaultForbidScheme ​

cangjie
public var defaultForbidScheme: ?String = None

功能：指定默认 forbid 方案名称。

类型：?String

var defaultChallengeScheme ​

cangjie
public var defaultChallengeScheme: ?String = None

功能：指定默认 challenge 方案名称。

类型：?String

prop schemes ​

cangjie
public prop schemes: ReadOnlyList<AuthenticationScheme>

功能：返回已注册身份验证方案列表。

类型：ReadOnlyList<AuthenticationScheme>

prop schemeMap ​

cangjie
public prop schemeMap: ReadOnlySet<String>

功能：返回已注册方案名称集合。

类型：ReadOnlySet<String>

func addScheme(String, (AuthenticationSchemeBuilder) -> Unit) ​

cangjie
public func addScheme(name: String, configureBuilder: (AuthenticationSchemeBuilder) -> Unit): Unit

功能：添加一个身份验证方案定义。

参数：

返回值：

  • Unit

异常：

  • IllegalArgumentException - 当方案名称已存在时抛出。