org.pac4j.oauth.client

Class BaseOAuth20Client<U extends OAuth20Profile>

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

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

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,U>

Direct Known Subclasses:

CasOAuthWrapperClient, FacebookClient, FoursquareClient, GitHubClient, Google2Client, LinkedIn2Client, OrcidClient, PayPalClient, StravaClient, VkClient, WindowsLiveClient, WordPressClient

public abstract class BaseOAuth20Client<U extends OAuth20Profile>
extends BaseOAuthClient<U>

This class is the base implementation for client supporting OAuth protocol version 2.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_CODE

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

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BaseOAuth20Client()

Method Summary

Modifier and Type	Method and Description
protected org.scribe.model.Token	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	getStateParameter(WebContext webContext)
protected boolean	isDirectRedirection()
protected abstract boolean	requiresStateParameter() Return if this client requires a state parameter.
protected String	retrieveAuthorizationUrl(WebContext context)

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

addAccessTokenToProfile, clone, createProxyRequest, extractUserProfile, getConnectTimeout, getKey, getMechanism, getProfileUrl, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, hasBeenCancelled, internalInit, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

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

addAuthorizationGenerator, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, newClient, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, setProfileCreator, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

OAUTH_CODE

public static final String OAUTH_CODE

See Also:

Constant Field Values

Constructor Detail

BaseOAuth20Client

public BaseOAuth20Client()

Method Detail

retrieveAuthorizationUrl

protected String retrieveAuthorizationUrl(WebContext context)

Specified by:

retrieveAuthorizationUrl in class BaseOAuthClient<U extends OAuth20Profile>

requiresStateParameter

protected abstract boolean requiresStateParameter()

Return if this client requires a state parameter.

Returns:

if this client requires a state parameter.

getStateParameter

protected String getStateParameter(WebContext webContext)

Overrides:

getStateParameter in class BaseClient<OAuthCredentials,U extends OAuth20Profile>

getOAuthCredentials

protected OAuthCredentials getOAuthCredentials(WebContext context)

Get the OAuth credentials from the web context.

Specified by:

getOAuthCredentials in class BaseOAuthClient<U extends OAuth20Profile>

Parameters:

context - the web context

Returns:

the OAuth credentials

getAccessToken

protected org.scribe.model.Token getAccessToken(OAuthCredentials credentials)

Get the access token from OAuth credentials.

Specified by:

getAccessToken in class BaseOAuthClient<U extends OAuth20Profile>

Parameters:

credentials - credentials

Returns:

the access token

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<OAuthCredentials,U extends OAuth20Profile>