Package org.pac4j.oauth.client

Class PayPalClient

  • All Implemented Interfaces:
    org.pac4j.core.client.Client
    public class PayPalClient
extends OAuth20Client

    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 Description
      static java.lang.String DEFAULT_SCOPE  

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

        ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

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

        logger, saveProfileInSession

    • Constructor Summary

      Constructors 
      Constructor Description
      PayPalClient()  
      PayPalClient​(java.lang.String key, java.lang.String secret)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getScope()  
      protected void internalInit()  
      void setScope​(java.lang.String scope)  

      • Methods inherited from class org.pac4j.core.client.IndirectClient

        afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

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

        addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, notifySessionRenewal, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

      • Methods inherited from class org.pac4j.core.util.InitializableObject

        init, isInitialized

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PayPalClient

        public PayPalClient()

      • PayPalClient

        public PayPalClient​(java.lang.String key,
                    java.lang.String secret)

    • Method Detail

      • getScope

        public java.lang.String getScope()

      • setScope

        public void setScope​(java.lang.String scope)