public static class AuHelper.OpenAuth extends Object
clientRegister(String, String) -> 返回客户端信息（客户端id，客户端name，客户端密钥，重定向url）createAuthorizationCode(String, String, String) -> 客户端id+登录用户+权限范围 、获得登录用户的授权码authorizeByCode(String, String, String)-> 利用授权码去获得IssueTokenauthorizeByPassword(String, String, String)-> 登录即可获得IssueToken| 构造器和说明 |
|---|
OpenAuth() |
| 限定符和类型 | 方法和说明 |
|---|---|
static boolean |
agreeAuthorize(String clientId)
客户端id有效，能够授权
|
static IssueToken |
authorizeByClient(String clientId,
String clientSecret,
String scope)
客户端登录 （授权类型 client_credentials）- 不需要登录
成功返回IssueToken |
static IssueToken |
authorizeByCode(String clientId,
String clientSecret,
String authorizationCode)
授权码登录 （授权类型 authorization_code）- 不需要登录
验证授权码是否有效，成功返回IssueToken |
static IssueToken |
authorizeByPassword(String clientId,
String clientSecret,
String scope)
登录授权（授权类型 password） - 需要登录
|
static IssueToken |
authorizeByPassword(String clientId,
String clientSecret,
String scope,
Object userId)
登录授权（授权类型 password） - 需要提前验证账号密码
|
static ClientDetails |
clientRegister()
注册一个客户端
|
static ClientDetails |
clientRegister(String clientName,
String redirectUrl)
注册一个客户端
|
static ClientDetails |
clientRegister(String clientId,
String clientName,
String redirectUrl)
注册一个客户端
|
static ClientDetails |
clientRegister(String clientId,
String clientSecret,
String clientName,
String redirectUrl)
注册一个客户端
|
static String |
createAuthorizationCode(String clientId,
String scope,
String redirectUrl)
若未登录，抛出
AuthorizationException 授权失败
指定(客户端, 授权范围) -> 获得登录用户的授权码
获取授权码 若redirectUrl与所注册客户端的redirectUrl不一致，抛出异常 |
static String |
createBasicScopeAuthorizationCode(String clientId,
String redirectUrl)
若未登录，抛出
AuthorizationException 授权失败
指定(客户端, 授权范围-默认权限) -> 获得登录用户的授权码
获取授权码 若redirectUrl与所注册客户端的redirectUrl不一致，抛出异常 |
static void |
deleteClient(String clientId)
根据clientId注销client
|
static ClientDetails |
findClient(String clientId)
根据clientId获取注册client的详细信息
|
static List<AuthorizedDeviceDetails> |
getAuthorizedDeviceDetails() |
static List<AuthorizedDeviceDetails> |
getAuthorizedDeviceDetailsAt(Object userId) |
static String |
getRedirectUrl(String clientId)
根据clientId获取注册client的RedirectUrl
|
static void |
removeAllAuthorizedDevice() |
static void |
removeAllAuthorizedDevice(Object userId) |
static void |
removeAuthorizedDevice(Object userId,
String id) |
static void |
removeAuthorizedDevice(String id) |
@Nullable public static IssueToken authorizeByCode(@NonNull String clientId, @NonNull String clientSecret, @NonNull String authorizationCode) throws AuthorizationException
验证授权码是否有效，成功返回IssueToken
clientId - 客户端idclientSecret - 客户端密钥authorizationCode - 授权码AuthorizationException - 验证失败，客户端密码错误 或者 授权码失效(过期 或者 已使用)@Nullable public static IssueToken authorizeByPassword(@NonNull String clientId, @NonNull String clientSecret, @NonNull String scope, @NonNull Object userId) throws AuthorizationException
clientId - 客户端idclientSecret - 客户端密钥scope - 授权范围userId - userIdAuthorizationException - 验证失败，客户端密码错误 或 未登录@Nullable public static IssueToken authorizeByPassword(@NonNull String clientId, @NonNull String clientSecret, @NonNull String scope) throws AuthorizationException
clientId - 客户端idclientSecret - 客户端密钥scope - 授权范围AuthorizationException - 验证失败，客户端密码错误 或 未登录@Nullable public static IssueToken authorizeByClient(@NonNull String clientId, @NonNull String clientSecret, @NonNull String scope) throws AuthorizationException
成功返回IssueToken
clientId - 客户端idclientSecret - 客户端密钥scope - 授权范围AuthorizationException - 客户端密码错误@NonNull public static String createAuthorizationCode(@NonNull String clientId, @NonNull String scope, @NonNull String redirectUrl) throws AuthorizationException
AuthorizationException 授权失败
指定(客户端, 授权范围) -> 获得登录用户的授权码
获取授权码 clientId - 客户端idscope - 授予的权限范围redirectUrl - 重定向urlAuthorizationException - 授权失败@NonNull public static String createBasicScopeAuthorizationCode(@NonNull String clientId, @NonNull String redirectUrl) throws AuthorizationException
AuthorizationException 授权失败
指定(客户端, 授权范围-默认权限) -> 获得登录用户的授权码
获取授权码 clientId - 客户端idredirectUrl - 重定向urlAuthorizationException - 授权失败public static boolean agreeAuthorize(@NonNull
String clientId)
clientId - 客户端id@NonNull public static ClientDetails findClient(@NonNull String clientId)
clientId - 客户端id@NonNull public static String getRedirectUrl(@NonNull String clientId)
clientId - 客户端idpublic static void removeAuthorizedDevice(@NonNull
String id)
throws NotLoginException
public static void removeAuthorizedDevice(@NonNull
Object userId,
@NonNull
String id)
public static void removeAllAuthorizedDevice()
throws NotLoginException
public static void removeAllAuthorizedDevice(@NonNull
Object userId)
@NonNull public static List<AuthorizedDeviceDetails> getAuthorizedDeviceDetails() throws NotLoginException
@NonNull public static List<AuthorizedDeviceDetails> getAuthorizedDeviceDetailsAt(@NonNull Object userId)
public static void deleteClient(@NonNull
String clientId)
clientId - 客户端idpublic static ClientDetails clientRegister()
public static ClientDetails clientRegister(@NonNull String clientName, @NonNull String redirectUrl)
clientName - 客户端名redirectUrl - 回调地址public static ClientDetails clientRegister(@NonNull String clientId, @NonNull String clientName, @NonNull String redirectUrl)
clientId - 客户端idclientName - 客户端名redirectUrl - 回调地址public static ClientDetails clientRegister(@NonNull String clientId, @NonNull String clientSecret, @NonNull String clientName, @NonNull String redirectUrl)
clientId - 客户端idclientSecret - 客户端密钥clientName - 客户端名redirectUrl - 回调地址Copyright © 2022. All rights reserved.