Spire 天擎

外观

class AuthorizationPolicyBuilder ​

cangjie
public class AuthorizationPolicyBuilder

功能：提供授权策略的构建器。

成员概览 ​

成员功能
init(Array<String>)使用认证方案集合创建授权策略构建器。
init(AuthorizationPolicy)使用现有授权策略创建授权策略构建器。
prop requirements获取当前构建器中的授权要求集合。
prop authenticationSchemes获取当前构建器中的认证方案集合。
func combine(AuthorizationPolicy)合并一个现有授权策略。
func requireClaim(String, Array<String>)添加基于声明值集合的授权要求。
func requireClaim(String)添加仅要求存在声明名称的授权要求。
func requireRole(Array<String>)添加角色授权要求。
func requireUserName(String)添加用户名授权要求。
func requireAssertion((AuthorizationHandlerContext) -> Bool)添加断言授权要求。
func requireAuthenticatedUser()添加要求用户已认证的授权要求。
func addRequirements(Array<IAuthorizationRequirement>)添加授权要求集合。
func addAuthenticationSchemes(Array<String>)添加认证方案集合。
func build()构建授权策略。

init(Array<String>) ​

cangjie
public init(authenticationSchemes: Array<String>)

功能：使用认证方案集合创建授权策略构建器。

参数：

  • authenticationSchemes: Array<String> - 认证方案集合。

init(AuthorizationPolicy) ​

cangjie
public init(policy: AuthorizationPolicy)

功能：使用现有授权策略创建授权策略构建器。

参数：

prop requirements ​

cangjie
public prop requirements: List<IAuthorizationRequirement>

功能：获取当前构建器中的授权要求集合。

类型：List<IAuthorizationRequirement>

prop authenticationSchemes ​

cangjie
public prop authenticationSchemes: List<String>

功能：获取当前构建器中的认证方案集合。

类型：List<String>

func combine(AuthorizationPolicy) ​

cangjie
public func combine(policy: AuthorizationPolicy): AuthorizationPolicyBuilder

功能：合并一个现有授权策略。

参数：

返回值：

func requireClaim(String, Array<String>) ​

cangjie
public func requireClaim(claimName: String, allowedValues: Array<String>): AuthorizationPolicyBuilder

功能：添加基于声明值集合的授权要求。

参数：

  • claimName: String - 声明名称。
  • allowedValues: Array<String> - 允许的声明值集合。

返回值：

func requireClaim(String) ​

cangjie
public func requireClaim(claimName: String): AuthorizationPolicyBuilder

功能：添加仅要求存在声明名称的授权要求。

参数：

  • claimName: String - 声明名称。

返回值：

func requireRole(Array<String>) ​

cangjie
public func requireRole(roles: Array<String>): AuthorizationPolicyBuilder

功能：添加角色授权要求。

参数：

  • roles: Array<String> - 允许的角色集合。

返回值：

func requireUserName(String) ​

cangjie
public func requireUserName(userName: String): AuthorizationPolicyBuilder

功能：添加用户名授权要求。

参数：

  • userName: String - 允许的用户名。

返回值：

func requireAssertion((AuthorizationHandlerContext) -> Bool) ​

cangjie
public func requireAssertion(handler: (AuthorizationHandlerContext) -> Bool): AuthorizationPolicyBuilder

功能：添加断言授权要求。

参数：

返回值：

func requireAuthenticatedUser() ​

cangjie
public func requireAuthenticatedUser(): AuthorizationPolicyBuilder

功能：添加要求用户已认证的授权要求。

返回值：

func addRequirements(Array<IAuthorizationRequirement>) ​

cangjie
public func addRequirements(requirements: Array<IAuthorizationRequirement>): AuthorizationPolicyBuilder

功能：添加授权要求集合。

参数：

返回值：

func addAuthenticationSchemes(Array<String>) ​

cangjie
public func addAuthenticationSchemes(schemes: Array<String>): AuthorizationPolicyBuilder

功能：添加认证方案集合。

参数：

  • schemes: Array<String> - 认证方案集合。

返回值：

func build() ​

cangjie
public func build(): AuthorizationPolicy

功能：构建授权策略。

返回值：