Class DirectCasClient
- java.lang.Object
-
- org.pac4j.core.util.InitializableObject
-
- org.pac4j.core.client.BaseClient<C>
-
- org.pac4j.core.client.DirectClient<TokenCredentials>
-
- org.pac4j.cas.client.direct.DirectCasClient
-
- All Implemented Interfaces:
Client<TokenCredentials>
public class DirectCasClient extends DirectClient<TokenCredentials>
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
CasClientinstead (this one is very specific and was designed for OAuth / OpenID Connect implementations in the CAS server.The configuration can be defined via the
configurationobject.As no session is meant to be created, this client does not handle CAS logout requests.
For proxy support, a
CasProxyReceptormust be defined in the configuration (the corresponding "callback filter" must be enabled) and set to the CAS configuration of this client. In that case, aCasProxyProfilewill be return (instead of aCasProfile) 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
-
-
Constructor Summary
Constructors Constructor Description DirectCasClient()DirectCasClient(CasConfiguration casConfiguration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidclientInit()protected voiddefaultAuthenticator(Authenticator authenticator)CallbackUrlResolvergetCallbackUrlResolver()CasConfigurationgetConfiguration()UrlResolvergetUrlResolver()protected Optional<TokenCredentials>retrieveCredentials(WebContext context)voidsetCallbackUrlResolver(CallbackUrlResolver callbackUrlResolver)voidsetConfiguration(CasConfiguration configuration)voidsetUrlResolver(UrlResolver urlResolver)StringtoString()-
Methods inherited from class org.pac4j.core.client.DirectClient
getCredentials, getLogoutAction, getRedirectionAction, internalInit
-
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getUserProfile, notifySessionRenewal, renewUserProfile, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator
-
Methods inherited from class org.pac4j.core.util.InitializableObject
init, isInitialized
-
-
-
-
Constructor Detail
-
DirectCasClient
public DirectCasClient()
-
DirectCasClient
public DirectCasClient(CasConfiguration casConfiguration)
-
-
Method Detail
-
clientInit
protected void clientInit()
- Specified by:
clientInitin classDirectClient<TokenCredentials>
-
retrieveCredentials
protected Optional<TokenCredentials> retrieveCredentials(WebContext context)
- Overrides:
retrieveCredentialsin classBaseClient<TokenCredentials>
-
defaultAuthenticator
protected void defaultAuthenticator(Authenticator authenticator)
- Overrides:
defaultAuthenticatorin classBaseClient<TokenCredentials>
-
getConfiguration
public CasConfiguration getConfiguration()
-
setConfiguration
public void setConfiguration(CasConfiguration configuration)
-
getUrlResolver
public UrlResolver getUrlResolver()
-
setUrlResolver
public void setUrlResolver(UrlResolver urlResolver)
-
getCallbackUrlResolver
public CallbackUrlResolver getCallbackUrlResolver()
-
setCallbackUrlResolver
public void setCallbackUrlResolver(CallbackUrlResolver callbackUrlResolver)
-
toString
public String toString()
- Overrides:
toStringin classBaseClient<TokenCredentials>
-
-