com.publiccms.common.base.oauth

类 AbstractOauth

java.lang.Object

com.publiccms.common.base.oauth.AbstractOauth

所有已实现的接口:

Config, Container<java.lang.String>, OauthGateway

直接已知子类:

QQOauthComponent, WechatOauthComponent, WeiboOauthComponent

public abstract class AbstractOauth
extends java.lang.Object
implements Config, OauthGateway

AbstractOauth

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	channel
static java.lang.String	CONFIG_APP_KEY
static java.lang.String	CONFIG_APP_SECRET
static java.lang.String	CONFIG_CODE
static java.lang.String	CONFIG_CODE_DESCRIPTION
static java.lang.String	CONFIG_RETURN_URL
protected static org.apache.http.impl.client.CloseableHttpClient	httpclient
protected org.apache.commons.logging.Log	log
protected java.lang.String	prefix

从接口继承的字段 com.publiccms.common.api.Config

CONFIG_CODE_DESCRIPTION_SUFFIX, CONFIG_CODE_SITE, CONFIG_CODE_SITEA_TTRIBUTE, CONFIGPREFIX, INPUT_TYPE_EDITORS, INPUTTYPE_BOOLEAN, INPUTTYPE_CAPTCHA, INPUTTYPE_CATEGORY, INPUTTYPE_CATEGORY_PATH, INPUTTYPE_CATEGORYTYPE, INPUTTYPE_COLOR, INPUTTYPE_CONTENT, INPUTTYPE_CONTENT_STATUS, INPUTTYPE_DATE, INPUTTYPE_DATETIME, INPUTTYPE_DEPT, INPUTTYPE_DICTIONARY, INPUTTYPE_EMAIL, INPUTTYPE_FILE, INPUTTYPE_IMAGE, INPUTTYPE_LANG, INPUTTYPE_MODULE, INPUTTYPE_NUMBER, INPUTTYPE_PASSWORD, INPUTTYPE_TAGTYPE, INPUTTYPE_TEMPLATE, INPUTTYPE_TEXT, INPUTTYPE_TEXTAREA, INPUTTYPE_USER

构造器概要

构造器

构造器和说明
AbstractOauth(java.lang.String channel)

方法概要

限定符和类型	方法和说明
boolean	enabled(short siteId)
boolean	exportable()
protected java.lang.String	get(java.lang.String url)
abstract OauthAccess	getAccessToken(short siteId, java.lang.String code)
java.lang.String	getAuthorizeUrl(short siteId, java.lang.String state)
java.lang.String	getChannel()
java.lang.String	getCode(short siteId, boolean showAll)
java.lang.String	getCodeDescription(java.util.Locale locale)
protected OauthConfig	getConfig(short siteId)
java.util.List<SysExtendField>	getExtendFieldList(SysSite site, java.util.Locale locale)
OauthAccess	getOpenId(short siteId, OauthAccess oauthInfo)
OauthAccess	getOpenId(short siteId, java.lang.String code)
protected java.lang.String	post(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> parameters)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.publiccms.common.api.Config

getCode, getMessage

从接口继承的方法 com.publiccms.common.api.oauth.OauthGateway

getAuthorizeUrl, getUserInfo, keyFunction

字段详细资料

CONFIG_CODE

public static final java.lang.String CONFIG_CODE

另请参阅:

常量字段值

CONFIG_APP_KEY

public static final java.lang.String CONFIG_APP_KEY

另请参阅:

常量字段值

CONFIG_APP_SECRET

public static final java.lang.String CONFIG_APP_SECRET

另请参阅:

常量字段值

CONFIG_RETURN_URL

public static final java.lang.String CONFIG_RETURN_URL

另请参阅:

常量字段值

CONFIG_CODE_DESCRIPTION

public static final java.lang.String CONFIG_CODE_DESCRIPTION

另请参阅:

常量字段值

httpclient

protected static final org.apache.http.impl.client.CloseableHttpClient httpclient

log

protected final org.apache.commons.logging.Log log

channel

protected java.lang.String channel

prefix

protected java.lang.String prefix

构造器详细资料

AbstractOauth

public AbstractOauth(java.lang.String channel)

参数:

channel -

方法详细资料

getChannel

public java.lang.String getChannel()

指定者:

getChannel 在接口中 OauthGateway

返回:

channel

enabled

public boolean enabled(short siteId)

指定者:

enabled 在接口中 OauthGateway

返回:

enabled

getConfig

protected OauthConfig getConfig(short siteId)

参数:

siteId -

返回:

get

protected java.lang.String get(java.lang.String url)
                        throws org.apache.http.client.ClientProtocolException,
                               java.io.IOException

抛出:

org.apache.http.client.ClientProtocolException

java.io.IOException

post

protected java.lang.String post(java.lang.String url,
                                java.util.Map<java.lang.String,java.lang.String> parameters)
                         throws org.apache.http.client.ClientProtocolException,
                                java.io.IOException

抛出:

org.apache.http.client.ClientProtocolException

java.io.IOException

getAuthorizeUrl

public java.lang.String getAuthorizeUrl(short siteId,
                                        java.lang.String state)

指定者:

getAuthorizeUrl 在接口中 OauthGateway

返回:

authorize url

getOpenId

public OauthAccess getOpenId(short siteId,
                             OauthAccess oauthInfo)
                      throws org.apache.http.client.ClientProtocolException,
                             java.io.IOException

参数:

siteId -

oauthInfo -

返回:

抛出:

org.apache.http.client.ClientProtocolException

java.io.IOException

getOpenId

public OauthAccess getOpenId(short siteId,
                             java.lang.String code)
                      throws org.apache.http.client.ClientProtocolException,
                             java.io.IOException

指定者:

getOpenId 在接口中 OauthGateway

返回:

oauth access

抛出:

org.apache.http.client.ClientProtocolException

java.io.IOException

getAccessToken

public abstract OauthAccess getAccessToken(short siteId,
                                           java.lang.String code)
                                    throws org.apache.http.client.ClientProtocolException,
                                           java.io.IOException

参数:

siteId -

code -

返回:

access token

抛出:

org.apache.http.client.ClientProtocolException

java.io.IOException

getCode

public java.lang.String getCode(short siteId,
                                boolean showAll)

指定者:

getCode 在接口中 Config

返回:

config code or null

getCodeDescription

public java.lang.String getCodeDescription(java.util.Locale locale)

指定者:

getCodeDescription 在接口中 Config

返回:

getExtendFieldList

public java.util.List<SysExtendField> getExtendFieldList(SysSite site,
                                                         java.util.Locale locale)

指定者:

getExtendFieldList 在接口中 Config

返回:

config extend field list

exportable

public boolean exportable()

指定者:

exportable 在接口中 Config

返回:

exportable