Class CasClient
- All Implemented Interfaces:
org.pac4j.core.client.Client
This class is the client to authenticate users on a CAS server for a web application in a stateful way: when trying to access a protected area, the user will be redirected to the CAS server for login and then back to the application (on the callback endpoint) and finally to the originally requested url.
The configuration can be defined via the configuration
object.
By default, the LogoutHandler
will be a DefaultLogoutHandler
. Use null
to
disable logout support.
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.
pac4j-cas-clientv4
module.- Since:
- 1.4.0
- Author:
- Jerome Leleu
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.protected void
internalInit
(boolean forceReinit) Deprecated.protected org.pac4j.core.http.callback.CallbackUrlResolver
Deprecated.void
notifySessionRenewal
(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore) Deprecated.void
setConfiguration
(CasConfiguration configuration) Deprecated.toString()
Deprecated.Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, beforeInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, 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, renewUserProfile, retrieveCredentials, 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
-
Constructor Details
-
CasClient
public CasClient()Deprecated. -
CasClient
Deprecated.
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) Deprecated.- Specified by:
internalInit
in classorg.pac4j.core.util.InitializableObject
-
newDefaultCallbackUrlResolver
protected org.pac4j.core.http.callback.CallbackUrlResolver newDefaultCallbackUrlResolver()Deprecated.- Overrides:
newDefaultCallbackUrlResolver
in classorg.pac4j.core.client.IndirectClient
-
notifySessionRenewal
public void notifySessionRenewal(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore) Deprecated.- Overrides:
notifySessionRenewal
in classorg.pac4j.core.client.BaseClient
-
getConfiguration
Deprecated. -
setConfiguration
Deprecated. -
toString
Deprecated.- Overrides:
toString
in classorg.pac4j.core.client.IndirectClient
-