org.pac4j.oauth.client

Class BaseOAuth10Client<U extends OAuth10Profile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

org.pac4j.oauth.client.BaseOAuth10Client<U>

All Implemented Interfaces:

Client<OAuthCredentials,U>

Direct Known Subclasses:

BitbucketClient, TwitterClient, YahooClient

public abstract class BaseOAuth10Client<U extends OAuth10Profile>
extends BaseOAuthClient<U,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

This class is the base implementation for client supporting OAuth protocol version 1.0.

Since:

1.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static String	OAUTH_TOKEN
static String	OAUTH_VERIFIER
static String	REQUEST_TOKEN

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

service

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

Constructor Summary

Constructors

Constructor and Description
BaseOAuth10Client()

Method Summary

Modifier and Type	Method and Description
protected void	addAccessTokenToProfile(U profile, com.github.scribejava.core.model.OAuth1Token accessToken) Add the access token to the profile (as an attribute).
protected com.github.scribejava.core.model.OAuth1Token	getAccessToken(OAuthCredentials credentials) Get the access token from OAuth credentials.
protected OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected String	getRequestTokenSessionAttributeName() Return the name of the attribute storing in session the request token.
protected String	retrieveAuthorizationUrl(WebContext context) Retrieve the authorization url to redirect to the OAuth provider.
protected void	signRequest(com.github.scribejava.core.model.OAuth1Token token, com.github.scribejava.core.model.OAuthRequest request)

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

buildOAuthConfig, createOAuthRequest, extractUserProfile, getApi, getConnectTimeout, getKey, getOAuthScope, getProfileUrl, getReadTimeout, getResponseType, getSecret, hasBeenCancelled, hasOAuthGrantType, internalInit, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, setConnectTimeout, setKey, setReadTimeout, setResponseType, setSecret, setTokenAsHeader

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, toString

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

addAuthorizationGenerator, addAuthorizationGenerators, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

OAUTH_TOKEN

public static final String OAUTH_TOKEN

See Also:

Constant Field Values

OAUTH_VERIFIER

public static final String OAUTH_VERIFIER

See Also:

Constant Field Values

REQUEST_TOKEN

public static final String REQUEST_TOKEN

See Also:

Constant Field Values

Constructor Detail

BaseOAuth10Client

public BaseOAuth10Client()

Method Detail

getRequestTokenSessionAttributeName

protected String getRequestTokenSessionAttributeName()

Return the name of the attribute storing in session the request token.

Returns:

the name of the attribute storing in session the request token

retrieveAuthorizationUrl

protected String retrieveAuthorizationUrl(WebContext context)
                                   throws HttpAction

Description copied from class: BaseOAuthClient

Retrieve the authorization url to redirect to the OAuth provider.

Specified by:

retrieveAuthorizationUrl in class BaseOAuthClient<U extends OAuth10Profile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

context - the web context

Returns:

the authorization url

Throws:

HttpAction - whether an additional HTTP action is required

getOAuthCredentials

protected OAuthCredentials getOAuthCredentials(WebContext context)
                                        throws HttpAction

Description copied from class: BaseOAuthClient

Get the OAuth credentials from the web context.

Specified by:

getOAuthCredentials in class BaseOAuthClient<U extends OAuth10Profile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

context - the web context

Returns:

the OAuth credentials

Throws:

HttpAction - whether an additional HTTP action is required

getAccessToken

protected com.github.scribejava.core.model.OAuth1Token getAccessToken(OAuthCredentials credentials)
                                                               throws HttpAction

Description copied from class: BaseOAuthClient

Get the access token from OAuth credentials.

Specified by:

getAccessToken in class BaseOAuthClient<U extends OAuth10Profile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

credentials - credentials

Returns:

the access token

Throws:

HttpAction - whether an additional HTTP action is required

addAccessTokenToProfile

protected void addAccessTokenToProfile(U profile,
                                       com.github.scribejava.core.model.OAuth1Token accessToken)

Description copied from class: BaseOAuthClient

Add the access token to the profile (as an attribute).

Specified by:

addAccessTokenToProfile in class BaseOAuthClient<U extends OAuth10Profile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>

Parameters:

profile - the user profile

accessToken - the access token

signRequest

protected void signRequest(com.github.scribejava.core.model.OAuth1Token token,
                           com.github.scribejava.core.model.OAuthRequest request)

Specified by:

signRequest in class BaseOAuthClient<U extends OAuth10Profile,com.github.scribejava.core.oauth.OAuth10aService,com.github.scribejava.core.model.OAuth1Token>