org.pac4j.oauth.profile.creator

Class OAuth20ProfileCreator<U extends OAuth20Profile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.oauth.profile.creator.OAuth20ProfileCreator<U>

All Implemented Interfaces:

ProfileCreator<OAuth20Credentials,U>

Direct Known Subclasses:

FacebookProfileCreator, FoursquareProfileCreator

public class OAuth20ProfileCreator<U extends OAuth20Profile>
extends InitializableWebObject

OAuth 2.0 profile creator.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected O	configuration
protected org.slf4j.Logger	logger
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
OAuth20ProfileCreator(OAuth20Configuration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	addAccessTokenToProfile(U profile, com.github.scribejava.core.model.OAuth2AccessToken accessToken) Add the access token to the profile (as an attribute).
U	create(C credentials, WebContext context) Create a profile from a credentials.
protected com.github.scribejava.core.model.OAuthRequest	createOAuthRequest(String url, com.github.scribejava.core.model.Verb verb) Create an OAuth request.
protected com.github.scribejava.core.model.OAuth2AccessToken	getAccessToken(OAuth20Credentials credentials) Get the access token from OAuth credentials.
protected void	internalInit(WebContext context) Internal initialization of the object.
protected U	retrieveUserProfileFromToken(T accessToken) Retrieve the user profile from the access token.
protected String	sendRequestForData(T accessToken, String dataUrl, com.github.scribejava.core.model.Verb verb) Make a request to get the data of the authenticated user for the provider.
protected void	signRequest(com.github.scribejava.core.model.OAuth2AccessToken accessToken, com.github.scribejava.core.model.OAuthRequest request) Sign the request.
String	toString()

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 final org.slf4j.Logger logger

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

configuration

protected final O extends OAuthConfiguration configuration

Constructor Detail

OAuth20ProfileCreator

public OAuth20ProfileCreator(OAuth20Configuration configuration)

Method Detail

getAccessToken

protected com.github.scribejava.core.model.OAuth2AccessToken getAccessToken(OAuth20Credentials credentials)
                                                                     throws HttpAction

Get the access token from OAuth credentials.

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.OAuth2AccessToken accessToken)

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

Parameters:

profile - the user profile

accessToken - the access token

signRequest

protected void signRequest(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                           com.github.scribejava.core.model.OAuthRequest request)

Sign the request.

Parameters:

accessToken - the token

request - the request

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

create

public U create(C credentials,
                WebContext context)
         throws HttpAction

Description copied from interface: ProfileCreator

Create a profile from a credentials.

Specified by:

create in interface ProfileCreator<C extends OAuthCredentials,U extends CommonProfile>

Parameters:

credentials - the given credentials

context - the web context

Returns:

the created profile

Throws:

HttpAction - whether an additional HTTP action is required

retrieveUserProfileFromToken

protected U retrieveUserProfileFromToken(T accessToken)
                                  throws HttpAction

Retrieve the user profile from the access token.

Parameters:

accessToken - the access token

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

sendRequestForData

protected String sendRequestForData(T accessToken,
                                    String dataUrl,
                                    com.github.scribejava.core.model.Verb verb)

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

Parameters:

accessToken - the access token

dataUrl - url of the data

verb - method used to request data

Returns:

the user data response

createOAuthRequest

protected com.github.scribejava.core.model.OAuthRequest createOAuthRequest(String url,
                                                                           com.github.scribejava.core.model.Verb verb)

Create an OAuth request.

Parameters:

url - the url to call

verb - method used to create the request

Returns:

the request

toString

public String toString()

Overrides:

toString in class Object