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 enum 
    WeiboClient.WeiboScope
    WeiboScope.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected WeiboClient.WeiboScope
    scope
     
    protected 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()
    Constructor for WeiboClient.
    WeiboClient(String key, String secret)
    Constructor for WeiboClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    WeiboClient.WeiboScope
    getScope()
    Getter for the field scope.
    protected void
    internalInit(boolean forceReinit)
    void
    setScope(WeiboClient.WeiboScope scope)
    Setter for the field scope.

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

    beforeInternalInit, getKey, getSecret, setKey, setSecret

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

    afterInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString

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

    addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials

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

    getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

    Methods inherited from class java.lang.Object

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