Package org.pac4j.oauth.client

Class WeiboClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient

org.pac4j.core.client.IndirectClient

org.pac4j.oauth.client.OAuth20Client

org.pac4j.oauth.client.WeiboClient

All Implemented Interfaces:

org.pac4j.core.client.Client

public class WeiboClient
extends OAuth20Client

This class is the OAuth client to authenticate users in Weibo using OAuth protocol version 2.0.

The scope is by default : WeiboClient.WeiboScope.EMAIL, but it can also but set to : WeiboClient.WeiboScope.ALL or WeiboClient.WeiboScope.EMAIL.

It returns a WeiboProfile.

More information at http://open.weibo.com/wiki/Oauth2/access_token/

Since:

3.1.0

Author:

zhangzhenli

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WeiboClient.WeiboScope	WeiboScope.

Field Summary

Fields

Modifier and Type	Field	Description
protected WeiboClient.WeiboScope	scope
protected java.lang.String	scopeValue

Fields inherited from class org.pac4j.oauth.client.OAuth20Client

configuration

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

Fields inherited from class org.pac4j.core.client.BaseClient

logger, saveProfileInSession

Constructor Summary

Constructors

Constructor	Description
WeiboClient()
WeiboClient(java.lang.String key, java.lang.String secret)

Method Summary

Modifier and Type	Method	Description
WeiboClient.WeiboScope	getScope()
protected void	internalInit()
void	setScope(WeiboClient.WeiboScope scope)

Methods inherited from class org.pac4j.oauth.client.OAuth20Client

beforeInternalInit, getConfiguration, getKey, getSecret, setConfiguration, setKey, setSecret, toString

Methods inherited from class org.pac4j.core.client.IndirectClient

afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

Methods inherited from class org.pac4j.core.util.InitializableObject

init, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

scope

protected WeiboClient.WeiboScope scope

scopeValue

protected java.lang.String scopeValue

Constructor Detail

WeiboClient

public WeiboClient()

WeiboClient

public WeiboClient(java.lang.String key,
                   java.lang.String secret)

Method Detail

internalInit

protected void internalInit()

Overrides:

internalInit in class OAuth20Client

getScope

public WeiboClient.WeiboScope getScope()

setScope

public void setScope(WeiboClient.WeiboScope scope)