Package org.pac4j.oauth.client

Class CasOAuthWrapperClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.oauth.client.OAuth20Client
org.pac4j.oauth.client.CasOAuthWrapperClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class CasOAuthWrapperClient extends OAuth20Client

This class is the OAuth client to authenticate users on CAS servers using OAuth wrapper.

The url of the OAuth endpoint of the CAS server must be set by using the setCasOAuthUrl(String) method.

It returns a CasOAuthWrapperProfile.

More information at https://wiki.jasig.org/display/CASUM/OAuth+server+support

Since:
1.3.0
Author:
Jerome Leleu

  • Field Summary

    Fields inherited from class org.pac4j.oauth.client.OAuth20Client

    configuration

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.github.scribejava.core.model.Verb
    getAccessTokenVerb()
     
    String
    getCasLogoutUrl()
     
    String
    getCasOAuthUrl()
     
    protected void
    internalInit(boolean forceReinit)
     
    boolean
    isImplicitFlow()
     
    boolean
    isJsonTokenExtractor()
     
    void
    setAccessTokenVerb(com.github.scribejava.core.model.Verb accessTokenVerb)
     
    void
    setCasLogoutUrl(String casLogoutUrl)
     
    void
    setCasOAuthUrl(String casOAuthUrl)
     
    void
    setImplicitFlow(boolean implicitFlow)
     
    void
    setJsonTokenExtractor(boolean jsonTokenExtractor)
     

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

    beforeInternalInit, getKey, getSecret, setKey, setSecret

    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, toString

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

    addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, isMultiProfile, 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

    getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CasOAuthWrapperClient

      public CasOAuthWrapperClient()

    • CasOAuthWrapperClient

      public CasOAuthWrapperClient(String key, String secret, String casOAuthUrl)

  • Method Details

    • internalInit

      protected void internalInit(boolean forceReinit)
      Overrides:
      internalInit in class OAuth20Client

    • getCasOAuthUrl

      public String getCasOAuthUrl()

    • setCasOAuthUrl

      public void setCasOAuthUrl(String casOAuthUrl)

    • isImplicitFlow

      public boolean isImplicitFlow()

    • setImplicitFlow

      public void setImplicitFlow(boolean implicitFlow)

    • getCasLogoutUrl

      public String getCasLogoutUrl()

    • setCasLogoutUrl

      public void setCasLogoutUrl(String casLogoutUrl)

    • isJsonTokenExtractor

      public boolean isJsonTokenExtractor()

    • setJsonTokenExtractor

      public void setJsonTokenExtractor(boolean jsonTokenExtractor)

    • getAccessTokenVerb

      public com.github.scribejava.core.model.Verb getAccessTokenVerb()

    • setAccessTokenVerb

      public void setAccessTokenVerb(com.github.scribejava.core.model.Verb accessTokenVerb)