Package org.pac4j.cas.client.direct

Class DirectCasClient

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.DirectClient
org.pac4j.cas.client.direct.DirectCasClient
All Implemented Interfaces:
org.pac4j.core.client.Client
public class DirectCasClient extends org.pac4j.core.client.DirectClient

This class is the direct client to authenticate users on a CAS server for a web application in a stateless way: when trying to access a protected area, the user will be redirected to the CAS server for login and then back directly to this originally requested url.

You should generally use the CasClient instead (this one is very specific and was designed for OAuth / OpenID Connect implementations in the CAS server.

The configuration can be defined via the configuration object.

As no session is meant to be created, this client does not handle CAS logout requests.

For proxy support, a CasProxyReceptor must be defined in the configuration (the corresponding "callback filter" must be enabled) and set to the CAS configuration of this client. In that case, a CasProxyProfile will be return (instead of a CasProfile) to be able to request proxy tickets.

Since:
1.9.2
Author:
Jerome Leleu

  • Field Summary

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

    logger, saveProfileInSession

  • Constructor Summary

    Constructors
    Constructor
    Description
    DirectCasClient()
     
    DirectCasClient(CasConfiguration casConfiguration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    defaultAuthenticator(org.pac4j.core.credentials.authenticator.Authenticator authenticator)
     
    org.pac4j.core.http.callback.CallbackUrlResolver
    getCallbackUrlResolver()
     
    CasConfiguration
    getConfiguration()
     
    org.pac4j.core.http.url.UrlResolver
    getUrlResolver()
     
    protected void
    internalInit(boolean forceReinits)
     
    protected Optional<org.pac4j.core.credentials.Credentials>
    retrieveCredentials(org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
     
    void
    setCallbackUrlResolver(org.pac4j.core.http.callback.CallbackUrlResolver callbackUrlResolver)
     
    void
    setConfiguration(CasConfiguration configuration)
     
    void
    setUrlResolver(org.pac4j.core.http.url.UrlResolver urlResolver)
     
    String
    toString()
     

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

    afterInternalInit, beforeInternalInit, getCredentials, getLogoutAction, getRedirectionAction

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

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

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

    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

    • DirectCasClient

      public DirectCasClient()

    • DirectCasClient

      public DirectCasClient(CasConfiguration casConfiguration)

  • Method Details

    • internalInit

      protected void internalInit(boolean forceReinits)
      Specified by:
      internalInit in class org.pac4j.core.util.InitializableObject

    • retrieveCredentials

      protected Optional<org.pac4j.core.credentials.Credentials> retrieveCredentials(org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
      Overrides:
      retrieveCredentials in class org.pac4j.core.client.BaseClient

    • defaultAuthenticator

      protected void defaultAuthenticator(org.pac4j.core.credentials.authenticator.Authenticator authenticator)
      Overrides:
      defaultAuthenticator in class org.pac4j.core.client.BaseClient

    • getConfiguration

      public CasConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration(CasConfiguration configuration)

    • getUrlResolver

      public org.pac4j.core.http.url.UrlResolver getUrlResolver()

    • setUrlResolver

      public void setUrlResolver(org.pac4j.core.http.url.UrlResolver urlResolver)

    • getCallbackUrlResolver

      public org.pac4j.core.http.callback.CallbackUrlResolver getCallbackUrlResolver()

    • setCallbackUrlResolver

      public void setCallbackUrlResolver(org.pac4j.core.http.callback.CallbackUrlResolver callbackUrlResolver)

    • toString

      public String toString()
      Overrides:
      toString in class org.pac4j.core.client.DirectClient