Auth2RequestHolder (ums-oauth 2.2.25 API)

java.lang.Object
- top.dcenter.ums.security.core.oauth.justauth.Auth2RequestHolder

所有已实现的接口:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
```
public final class Auth2RequestHolder
extends Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
```
JustAuth内置的各api需要的url，用枚举类分平台类型管理

版本:

V1.0 Created by 2020-10-06 18:09

作者:

YongWu zheng

字段概要

字段
限定符和类型	字段和说明
`static String`	`AUTH_REQUEST_PACKAGE` `AuthDefaultRequest` 子类的包名
`static String`	`AUTH_REQUEST_PREFIX` `AuthDefaultRequest` 子类类名前缀
`static String`	`AUTH_REQUEST_SUFFIX` `AuthDefaultRequest` 子类类名后缀

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`afterPropertiesSet()`
`static Collection<String>`	`getAllProviderIds()` 获取有效的 providerIds
`static Auth2DefaultRequest`	`getAuth2DefaultRequest(String providerId)` 根据 providerId 获取 `Auth2DefaultRequest`
`static Class<?>`	`getAuthRequestClassBySource(me.zhyd.oauth.config.AuthSource source)` 根据 `AuthSource` 获取对应的 `AuthDefaultRequest` 子类的 Class
`static Auth2RequestHolder`	`getInstance()` 获取单例模式 `Auth2RequestHolder`
`static String`	`getProviderId(me.zhyd.oauth.config.AuthSource source)` 根据 `AuthSource` 获取 providerId, 注意: 必须在程序初始化后完成后才能调用.
`static String`	`getProviderIdBySource(me.zhyd.oauth.config.AuthSource source)` 根据 `AuthSource` 获取对应的 `Auth2Properties` 字段名称(即 providerId)
`static Collection<String>`	`getValidProviderIds()` 获取有效的 providerIds
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`static void`	`setAuthCustomizeSource(AuthCustomizeSource authCustomizeSource)` 当 `authCustomizeSource` 为 null 时, authCustomizeSource 将会被设置到 `authCustomizeSource`; 否则什么都不做.
`static void`	`setAuthGitlabPrivateSource(AuthGitlabPrivateSource authGitlabPrivateSource)` 当 `authGitlabPrivateSource` 为 null 时, authGitlabPrivateSource 将会被设置到 `authGitlabPrivateSource`; 否则什么都不做.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - AUTH_REQUEST_PACKAGE
```
public static final String AUTH_REQUEST_PACKAGE
```
    AuthDefaultRequest 子类的包名
    
    另请参阅:
    
    常量字段值
  - AUTH_REQUEST_PREFIX
```
public static final String AUTH_REQUEST_PREFIX
```
    AuthDefaultRequest 子类类名前缀
    
    另请参阅:
    
    常量字段值
  - AUTH_REQUEST_SUFFIX
```
public static final String AUTH_REQUEST_SUFFIX
```
    AuthDefaultRequest 子类类名后缀
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static Auth2RequestHolder getInstance()
```
    获取单例模式 Auth2RequestHolder
    
    返回:
    
    返回 Auth2RequestHolder
  - setAuthCustomizeSource
```
public static void setAuthCustomizeSource(AuthCustomizeSource authCustomizeSource)
```
    当 authCustomizeSource 为 null 时, authCustomizeSource 将会被设置到 authCustomizeSource; 否则什么都不做.
    
    参数:
    
    authCustomizeSource - auth2 Customize Source
  - setAuthGitlabPrivateSource
```
public static void setAuthGitlabPrivateSource(AuthGitlabPrivateSource authGitlabPrivateSource)
```
    当 authGitlabPrivateSource 为 null 时, authGitlabPrivateSource 将会被设置到 authGitlabPrivateSource; 否则什么都不做.
    
    参数:
    
    authGitlabPrivateSource - auth2 GitlabPrivate Source
  - getAuth2DefaultRequest
```
@Nullable
public static Auth2DefaultRequest getAuth2DefaultRequest(String providerId)
```
    根据 providerId 获取 Auth2DefaultRequest
    
    参数:
    
    providerId - providerId
    
    返回:
    
    返回 Auth2DefaultRequest, 当没有对应的 Auth2DefaultRequest 时, 返回 null
  - getProviderId
```
public static String getProviderId(me.zhyd.oauth.config.AuthSource source)
```
    根据 AuthSource 获取 providerId, 注意: 必须在程序初始化后完成后才能调用.
    
    参数:
    
    source - AuthSource
    
    返回:
    
    返回 providerId, 没有对应的第三方则返回 null
  - getValidProviderIds
```
public static Collection<String> getValidProviderIds()
```
    获取有效的 providerIds
    
    返回:
    
    有效的 providerId Set
  - getAllProviderIds
```
public static Collection<String> getAllProviderIds()
```
    获取有效的 providerIds
    
    返回:
    
    有效的 providerId Set
  - setApplicationContext
```
public void setApplicationContext(@NonNull
                                  org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    指定者:
    
    setApplicationContext 在接口中 org.springframework.context.ApplicationContextAware
    
    抛出:
    
    org.springframework.beans.BeansException
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    指定者:
    
    afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean
    
    抛出:
    
    Exception
  - getProviderIdBySource
```
public static String getProviderIdBySource(@NonNull
                                           me.zhyd.oauth.config.AuthSource source)
```
    根据 AuthSource 获取对应的 Auth2Properties 字段名称(即 providerId)
    
    参数:
    
    source - AuthSource
    
    返回:
    
    AuthSource 对应的 Auth2Properties 字段名称(即 providerId)
  - getAuthRequestClassBySource
```
@NonNull
public static Class<?> getAuthRequestClassBySource(@NonNull
                                                             me.zhyd.oauth.config.AuthSource source)
                                                      throws ClassNotFoundException
```
    根据 AuthSource 获取对应的 AuthDefaultRequest 子类的 Class
    
    参数:
    
    source - AuthSource
    
    返回:
    
    返回 AuthSource 对应的 AuthDefaultRequest 子类的 Class
    
    抛出:
    
    ClassNotFoundException

类 Auth2RequestHolder

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

AUTH_REQUEST_PACKAGE

AUTH_REQUEST_PREFIX

AUTH_REQUEST_SUFFIX

方法详细资料

getInstance

setAuthCustomizeSource

setAuthGitlabPrivateSource

getAuth2DefaultRequest

getProviderId

getValidProviderIds

getAllProviderIds

setApplicationContext

afterPropertiesSet

getProviderIdBySource

getAuthRequestClassBySource