org.pac4j.oauth.client

Class BaseOAuth20StateClient<U extends OAuth20Profile>

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.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

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

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

All Implemented Interfaces:

Client<OAuthCredentials,U>

Direct Known Subclasses:

FacebookClient, GenericOAuth20StateClient, Google2Client, LinkedIn2Client

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

This class is the base implementation for client supporting OAuth protocol version 2.0 with the state parameter.

Since:

1.8.4

Author:

James Kleeh

Field Summary

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

logger, OAUTH_CODE

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
BaseOAuth20StateClient()

Method Summary

Modifier and Type	Method and Description
protected com.github.scribejava.core.model.OAuthConfig	buildOAuthConfig(WebContext context) Build an OAuth configuration.
protected OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
String	getStateData()
protected String	getStateParameter(WebContext context) Return the state parameter required by some security protocols like SAML or OAuth.
protected String	retrieveAuthorizationUrl(WebContext context) Retrieve the authorization url to redirect to the OAuth provider.
void	setStateData(String stateData)

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

addAccessTokenToProfile, getAccessToken, signRequest

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

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, 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

Constructor Detail

BaseOAuth20StateClient

public BaseOAuth20StateClient()

Method Detail

getStateParameter

protected String getStateParameter(WebContext context)

Description copied from class: IndirectClient

Return the state parameter required by some security protocols like SAML or OAuth.

Overrides:

getStateParameter in class IndirectClient<OAuthCredentials,U extends OAuth20Profile>

Parameters:

context - web context

Returns:

the state

buildOAuthConfig

protected com.github.scribejava.core.model.OAuthConfig buildOAuthConfig(WebContext context)

Description copied from class: BaseOAuthClient

Build an OAuth configuration.

Overrides:

buildOAuthConfig in class BaseOAuthClient<U extends OAuth20Profile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

context - the web context

Returns:

the OAuth configuration

retrieveAuthorizationUrl

protected String retrieveAuthorizationUrl(WebContext context)
                                   throws HttpAction

Description copied from class: BaseOAuthClient

Retrieve the authorization url to redirect to the OAuth provider.

Overrides:

retrieveAuthorizationUrl in class BaseOAuth20Client<U extends OAuth20Profile>

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.

Overrides:

getOAuthCredentials in class BaseOAuth20Client<U extends OAuth20Profile>

Parameters:

context - the web context

Returns:

the OAuth credentials

Throws:

HttpAction - whether an additional HTTP action is required

getStateData

public String getStateData()

setStateData

public void setStateData(String stateData)