org.pac4j.oauth.client

Class BaseOAuthClient<U extends OAuth20Profile>

java.lang.Object

org.pac4j.core.util.InitializableObject

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

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

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,U>

Direct Known Subclasses:

BaseOAuth10Client, BaseOAuth20Client

public abstract class BaseOAuthClient<U extends OAuth20Profile>
extends BaseClient<OAuthCredentials,U>

This class is a base implementation for an OAuth protocol client based on the Scribe library. It should work for all OAuth clients. In subclasses, some methods are to be implemented / customized for specific needs depending on the client.

Since:

1.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectTimeout
protected String	key
protected static org.slf4j.Logger	logger
protected String	proxyHost
protected int	proxyPort
protected int	readTimeout
protected String	secret
protected org.scribe.oauth.OAuthService	service
protected boolean	tokenAsHeader

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
BaseOAuthClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAccessTokenToProfile(U profile, org.scribe.model.Token accessToken) Add the access token to the profile (as an attribute).
BaseOAuthClient<U>	clone()
protected ProxyOAuthRequest	createProxyRequest(String url) Create a proxy request.
protected abstract U	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected abstract org.scribe.model.Token	getAccessToken(OAuthCredentials credentials) Get the access token from OAuth credentials.
int	getConnectTimeout()
String	getKey()
protected abstract OAuthCredentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected abstract String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
Protocol	getProtocol()
String	getProxyHost()
int	getProxyPort()
int	getReadTimeout()
String	getSecret()
U	getUserProfile(String accessToken) Get the user profile from the access token.
protected abstract boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
boolean	isTokenAsHeader()
protected abstract String	retrieveAuthorizationUrl(WebContext context)
protected OAuthCredentials	retrieveCredentials(WebContext context) Get the credentials from the web context.
protected RedirectAction	retrieveRedirectAction(WebContext context) Get the redirection url.
protected U	retrieveUserProfile(OAuthCredentials credentials, WebContext context) Get the user profile from the credentials.
protected U	retrieveUserProfileFromToken(org.scribe.model.Token accessToken) Retrieve the user profile from the access token.
String	sendRequestForData(OAuth10Profile profile, String dataUrl) Make a request to the OAuth provider to access a protected resource.
protected String	sendRequestForData(org.scribe.model.Token accessToken, String dataUrl) Make a request to get the data of the authenticated user for the provider.
void	setConnectTimeout(int connectTimeout)
void	setKey(String key)
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setReadTimeout(int readTimeout)
void	setSecret(String secret)
void	setTokenAsHeader(boolean tokenAsHeader)

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

addAuthorizationGenerator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getRedirectAction, getRedirectionUrl, getUserProfile, isDirectRedirection, isEnableContextualRedirects, newClient, prependHostToUrlIfNotPresent, redirect, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, 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

service

protected org.scribe.oauth.OAuthService service

key

protected String key

secret

protected String secret

tokenAsHeader

protected boolean tokenAsHeader

connectTimeout

protected int connectTimeout

readTimeout

protected int readTimeout

proxyHost

protected String proxyHost

proxyPort

protected int proxyPort

Constructor Detail

BaseOAuthClient

public BaseOAuthClient()

Method Detail

internalInit

protected void internalInit()

Specified by:

internalInit in class InitializableObject

clone

public BaseOAuthClient<U> clone()

Overrides:

clone in class BaseClient<OAuthCredentials,U extends OAuth20Profile>

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Get the redirection url.

Specified by:

retrieveRedirectAction in class BaseClient<OAuthCredentials,U extends OAuth20Profile>

Parameters:

context -

Returns:

the redirection url

retrieveAuthorizationUrl

protected abstract String retrieveAuthorizationUrl(WebContext context)

retrieveCredentials

protected OAuthCredentials retrieveCredentials(WebContext context)

Get the credentials from the web context.

Specified by:

retrieveCredentials in class BaseClient<OAuthCredentials,U extends OAuth20Profile>

Parameters:

context -

Returns:

the credentials

hasBeenCancelled

protected abstract boolean hasBeenCancelled(WebContext context)

Return if the authentication has been cancelled.

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.

getOAuthCredentials

protected abstract OAuthCredentials getOAuthCredentials(WebContext context)

Get the OAuth credentials from the web context.

Parameters:

context -

Returns:

the OAuth credentials

retrieveUserProfile

protected U retrieveUserProfile(OAuthCredentials credentials,
                    WebContext context)

Get the user profile from the credentials.

Specified by:

retrieveUserProfile in class BaseClient<OAuthCredentials,U extends OAuth20Profile>

Parameters:

credentials -

Returns:

the user profile

getUserProfile

public U getUserProfile(String accessToken)

Get the user profile from the access token.

Parameters:

accessToken -

Returns:

the user profile

getAccessToken

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

Get the access token from OAuth credentials.

Parameters:

credentials -

Returns:

the access token

retrieveUserProfileFromToken

protected U retrieveUserProfileFromToken(org.scribe.model.Token accessToken)

Retrieve the user profile from the access token.

Parameters:

accessToken -

Returns:

the user profile

getProfileUrl

protected abstract String getProfileUrl(org.scribe.model.Token accessToken)

Retrieve the url of the profile of the authenticated user for the provider.

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

Returns:

the url of the user profile given by the provider

sendRequestForData

protected String sendRequestForData(org.scribe.model.Token accessToken,
                        String dataUrl)

Make a request to get the data of the authenticated user for the provider.

Parameters:

accessToken -

dataUrl -

Returns:

the user data response

sendRequestForData

public String sendRequestForData(OAuth10Profile profile,
                        String dataUrl)

Make a request to the OAuth provider to access a protected resource. The profile should contain a valid access token (and secret if needed).

Parameters:

profile -

dataUrl -

Returns:

the body of the requested resource

createProxyRequest

protected ProxyOAuthRequest createProxyRequest(String url)

Create a proxy request.

Parameters:

url -

Returns:

a proxy request

extractUserProfile

protected abstract U extractUserProfile(String body)

Extract the user profile from the response (JSON, XML...) of the profile url.

Parameters:

body -

Returns:

the user profile object

addAccessTokenToProfile

protected void addAccessTokenToProfile(U profile,
                           org.scribe.model.Token accessToken)

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

Parameters:

profile -

accessToken -

setKey

public void setKey(String key)

setSecret

public void setSecret(String secret)

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

setReadTimeout

public void setReadTimeout(int readTimeout)

getKey

public String getKey()

getSecret

public String getSecret()

getConnectTimeout

public int getConnectTimeout()

getReadTimeout

public int getReadTimeout()

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

getProxyPort

public int getProxyPort()

setProxyPort

public void setProxyPort(int proxyPort)

isTokenAsHeader

public boolean isTokenAsHeader()

setTokenAsHeader

public void setTokenAsHeader(boolean tokenAsHeader)

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in class BaseClient<OAuthCredentials,U extends OAuth20Profile>