org.pac4j.oauth.client

Class PayPalClient

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

org.pac4j.oauth.client.PayPalClient

All Implemented Interfaces:

Client<OAuthCredentials,PayPalProfile>

public class PayPalClient
extends BaseOAuth20Client<PayPalProfile>

This class is the OAuth client to authenticate users in PayPal.

By default, the following scope is requested to PayPal : openid profile email address.

The scope can be defined to require permissions from the user and retrieve attributes from PayPal, by using the setScope(String) method.

It returns a PayPalProfile.

More information at https://developer.paypal.com/webapps/developer/docs/integration/direct/log-in-with-paypal/detailed/

Since:

1.4.2

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SCOPE
protected String	scope

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
PayPalClient()
PayPalClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected PayPalProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth20Service>	getApi() Define the OAuth API for this client.
protected String	getOAuthScope() Define the OAuth scope for this client.
protected String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken) Retrieve the url of the profile of the authenticated user for the provider.
String	getScope()
protected boolean	hasOAuthGrantType() Whether the grant type must be added.
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setScope(String scope)

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

addAccessTokenToProfile, getAccessToken, getOAuthCredentials, retrieveAuthorizationUrl, signRequest

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

buildOAuthConfig, createOAuthRequest, getConnectTimeout, getKey, getReadTimeout, getResponseType, getSecret, hasBeenCancelled, 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, getStateParameter, 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

Field Detail

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

scope

protected String scope

Constructor Detail

PayPalClient

public PayPalClient()

PayPalClient

public PayPalClient(String key,
                    String secret)

Method Detail

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

context - the web context

getApi

protected com.github.scribejava.core.builder.api.BaseApi<com.github.scribejava.core.oauth.OAuth20Service> getApi()

Description copied from class: BaseOAuthClient

Define the OAuth API for this client.

Specified by:

getApi in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Returns:

the OAuth API

getOAuthScope

protected String getOAuthScope()

Description copied from class: BaseOAuthClient

Define the OAuth scope for this client.

Overrides:

getOAuthScope in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Returns:

the OAuth scope

hasOAuthGrantType

protected boolean hasOAuthGrantType()

Description copied from class: BaseOAuthClient

Whether the grant type must be added.

Overrides:

hasOAuthGrantType in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Returns:

Whether the grant type must be added

getProfileUrl

protected String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken)

Description copied from class: BaseOAuthClient

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

Specified by:

getProfileUrl in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

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

Returns:

the url of the user profile given by the provider

extractUserProfile

protected PayPalProfile extractUserProfile(String body)
                                    throws HttpAction

Description copied from class: BaseOAuthClient

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

Specified by:

extractUserProfile in class BaseOAuthClient<PayPalProfile,com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

body - the response body

Returns:

the user profile object

Throws:

HttpAction - whether an additional HTTP action is required

getScope

public String getScope()

setScope

public void setScope(String scope)