interface IAuthenticationSchemeProvider
cangjie
public interface IAuthenticationSchemeProvider功能:定义身份验证方案注册与查询能力。
成员概览
| 成员 | 功能 |
|---|---|
| func addScheme(AuthenticationScheme) | 添加一个身份验证方案。 |
| func tryAddScheme(AuthenticationScheme) | 尝试添加一个身份验证方案。 |
| func removeScheme(String) | 按名称移除身份验证方案。 |
| func getAllSchemes() | 返回所有已注册的身份验证方案。 |
| func getScheme(String) | 按名称查找身份验证方案。 |
| func getDefaultAuthenticateScheme() | 返回默认身份验证方案。 |
| func getDefaultChallengeScheme() | 返回默认质询方案。 |
| func getDefaultForbidScheme() | 返回默认禁止访问方案。 |
| func getRequestHandlerSchemes() | 返回可处理请求的方案集合。 |
| func getDefaultSignInScheme() | 返回默认登录方案。 |
| func getDefaultSignOutScheme() | 返回默认登出方案。 |
func addScheme(AuthenticationScheme)
cangjie
func addScheme(scheme: AuthenticationScheme): Unit功能:添加一个身份验证方案。
参数:
- scheme: AuthenticationScheme - 待添加的身份验证方案。
返回值:
Unit
func tryAddScheme(AuthenticationScheme)
cangjie
func tryAddScheme(scheme: AuthenticationScheme): Bool功能:尝试添加一个身份验证方案。
参数:
- scheme: AuthenticationScheme - 待添加的身份验证方案。
返回值:
Bool- 添加成功时返回 true。
func removeScheme(String)
cangjie
func removeScheme(name: String): Unit功能:按名称移除身份验证方案。
参数:
- name:
String- 待移除的方案名称。
返回值:
Unit
func getAllSchemes()
cangjie
func getAllSchemes(): Collection<AuthenticationScheme>功能:返回所有已注册的身份验证方案。
返回值:
- Collection<AuthenticationScheme> - 已注册身份验证方案集合。
func getScheme(String)
cangjie
func getScheme(name: String): ?AuthenticationScheme功能:按名称查找身份验证方案。
参数:
- name:
String- 方案名称。
返回值:
- ?AuthenticationScheme - 对应的身份验证方案;不存在时返回 None。
func getDefaultAuthenticateScheme()
cangjie
func getDefaultAuthenticateScheme(): ?AuthenticationScheme功能:返回默认身份验证方案。
返回值:
- ?AuthenticationScheme - 默认身份验证方案;未配置时返回 None。
func getDefaultChallengeScheme()
cangjie
func getDefaultChallengeScheme(): ?AuthenticationScheme功能:返回默认质询方案。
返回值:
- ?AuthenticationScheme - 默认质询方案;未配置时返回 None。
func getDefaultForbidScheme()
cangjie
func getDefaultForbidScheme(): ?AuthenticationScheme功能:返回默认禁止访问方案。
返回值:
- ?AuthenticationScheme - 默认禁止访问方案;未配置时返回 None。
func getRequestHandlerSchemes()
cangjie
func getRequestHandlerSchemes(): Collection<AuthenticationScheme>功能:返回可处理请求的方案集合。
返回值:
- Collection<AuthenticationScheme> - 请求处理方案集合。
func getDefaultSignInScheme()
cangjie
func getDefaultSignInScheme(): ?AuthenticationScheme功能:返回默认登录方案。
返回值:
- ?AuthenticationScheme - 默认登录方案;未配置时返回 None。
func getDefaultSignOutScheme()
cangjie
func getDefaultSignOutScheme(): ?AuthenticationScheme功能:返回默认登出方案。
返回值:
- ?AuthenticationScheme - 默认登出方案;未配置时返回 None。