org.pac4j.cas.client

Class CasClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<TokenCredentials,CommonProfile>

org.pac4j.cas.client.CasClient

All Implemented Interfaces:

Client<TokenCredentials,CommonProfile>

public class CasClient
extends IndirectClient<TokenCredentials,CommonProfile>

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.

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

Constructor Summary

Constructors

Constructor and Description
CasClient()
CasClient(CasConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit()
CasConfiguration	getConfiguration()
void	notifySessionRenewal(java.lang.String oldSessionId, WebContext context)
void	setConfiguration(CasConfiguration configuration)
java.lang.String	toString()

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator

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

init

Methods inherited from class java.lang.Object

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

Constructor Detail

CasClient

public CasClient()

CasClient

public CasClient(CasConfiguration configuration)

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class IndirectClient<TokenCredentials,CommonProfile>

notifySessionRenewal

public void notifySessionRenewal(java.lang.String oldSessionId,
                                 WebContext context)

Overrides:

notifySessionRenewal in class BaseClient<TokenCredentials,CommonProfile>

getConfiguration

public CasConfiguration getConfiguration()

setConfiguration

public void setConfiguration(CasConfiguration configuration)

toString

public java.lang.String toString()

Overrides:

toString in class IndirectClient<TokenCredentials,CommonProfile>