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/
PayPalProfile
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SCOPE |
protected String |
scope |
logger, OAUTH_CODE
connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER
Constructor and Description |
---|
PayPalClient() |
PayPalClient(String key,
String secret) |
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 String |
getProfileUrl(org.scribe.model.Token accessToken)
Retrieve the url of the profile of the authenticated user for the provider.
|
String |
getScope() |
protected boolean |
hasBeenCancelled(WebContext context)
Return if the authentication has been cancelled.
|
protected void |
internalInit(WebContext context)
Internal initialization of the object.
|
protected PayPalClient |
newClient()
Create a new instance of the client.
|
void |
setScope(String scope) |
getAccessToken, getOAuthCredentials, isDirectRedirection, retrieveAuthorizationUrl
addAccessTokenToProfile, clone, createProxyRequest, getClientType, getConnectTimeout, getKey, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader
computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl
addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString
init, reinit
public static final String DEFAULT_SCOPE
protected String scope
protected PayPalClient newClient()
BaseClient
newClient
in class BaseClient<OAuthCredentials,PayPalProfile>
protected void internalInit(WebContext context)
InitializableWebObject
internalInit
in class BaseOAuthClient<PayPalProfile>
context
- the web contextprotected String getProfileUrl(org.scribe.model.Token accessToken)
BaseOAuthClient
getProfileUrl
in class BaseOAuthClient<PayPalProfile>
accessToken
- only used when constructing dynamic urls from data in the tokenprotected PayPalProfile extractUserProfile(String body)
BaseOAuthClient
extractUserProfile
in class BaseOAuthClient<PayPalProfile>
body
- the response bodypublic String getScope()
public void setScope(String scope)
protected boolean hasBeenCancelled(WebContext context)
BaseOAuthClient
hasBeenCancelled
in class BaseOAuthClient<PayPalProfile>
context
- the web context.Copyright © 2016. All rights reserved.