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>

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

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

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,U>

Direct Known Subclasses:

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

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

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BaseOAuth20StateClient()

Method Summary

Modifier and Type	Method and Description
protected String	getAuthorizationUrl(String state)
protected OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected String	getState()
protected String	retrieveAuthorizationUrl(WebContext context)
void	setState(String stateParameter)

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

getAccessToken, isDirectRedirection

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

addAccessTokenToProfile, clone, createProxyRequest, extractUserProfile, getClientType, getConnectTimeout, getKey, 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.IndirectClient

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

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

addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, newClient, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString

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

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseOAuth20StateClient

public BaseOAuth20StateClient()

Method Detail

getState

protected String getState()

setState

public void setState(String stateParameter)

getAuthorizationUrl

protected String getAuthorizationUrl(String state)

retrieveAuthorizationUrl

protected String retrieveAuthorizationUrl(WebContext context)

Overrides:

retrieveAuthorizationUrl in class BaseOAuth20Client<U extends OAuth20Profile>

getOAuthCredentials

protected OAuthCredentials getOAuthCredentials(WebContext context)

Description copied from class: BaseOAuth20Client

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