org.pac4j.cas.client

Class CasClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

org.pac4j.core.client.IndirectClient<CasCredentials,CasProfile>

org.pac4j.cas.client.CasClient

All Implemented Interfaces:

Cloneable, Client<CasCredentials,CasProfile>

public class CasClient
extends IndirectClient<CasCredentials,CasProfile>

This class is the client to authenticate users on a CAS server.

The CAS service url is defined by the callback url which must be defined on the services back office of the CAS server.

The CAS server login url is defined by the setCasLoginUrl(String) method and the CAS server prefix url is settable by the setCasPrefixUrl(String) method. If the CAS prefix url is not defined, the CAS prefix url is computed from the CAS server login url and vice versa.

The CAS protocol is defined by the setCasProtocol(CasProtocol) method and CasClient.CasProtocol enumeration. It can be :

• CAS 1.0
• CAS 2.0 : service tickets only (by default)
• CAS 2.0 : service & proxy tickets. In this case, it's possible to define if any proxy is accepted by using the setAcceptAnyProxy(boolean) method or the list of accepted proxies by using the setAllowedProxyChains(ProxyList) method.
• SAML.

For the CAS round-trip :

• the renew parameter can be set by using the setRenew(boolean) method
• the gateway parameter can be set by using the setGateway(boolean) method.

This client handles CAS logout calls from the CAS server, using the LogoutHandler interface. It's defined by default as the NoLogoutHandler class, which does not perform the logout. Though, in J2E context, it can be defined to the CasSingleSignOutHandler class by using the setLogoutHandler(LogoutHandler) method. It must be used in association with the CAS client listener : SingleSignOutHttpSessionListener.

To require a proxy granting ticket, the CasProxyReceptor class must be used and referenced in this class through the setCasProxyReceptor(CasProxyReceptor) method.

It returns a CasProfile or a CasProxyProfile if the casProxyReceptor is defined (this CAS client acts as a proxy).

Since:

1.4.0

Author:

Jerome Leleu

See Also:

CasProfile

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CasClient.CasProtocol

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	acceptAnyProxy
protected org.jasig.cas.client.validation.ProxyList	allowedProxyChains
protected String	casLoginUrl
protected String	casPrefixUrl
protected CasClient.CasProtocol	casProtocol
protected CasProxyReceptor	casProxyReceptor
protected String	encoding
protected boolean	gateway
protected static org.slf4j.Logger	logger
protected LogoutHandler	logoutHandler
protected boolean	renew
protected static String	SERVICE_PARAMETER
static String	SERVICE_TICKET_PARAMETER
protected org.jasig.cas.client.validation.TicketValidator	ticketValidator
protected long	timeTolerance

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
CasClient()
CasClient(String casLoginUrl)
CasClient(String casLoginUrl, CasClient.CasProtocol casProtocol)
CasClient(String casLoginUrl, String casPrefixUrl)

Method Summary

Modifier and Type	Method and Description
org.jasig.cas.client.validation.ProxyList	getAllowedProxyChains()
String	getCasLoginUrl()
String	getCasPrefixUrl()
CasClient.CasProtocol	getCasProtocol()
CasProxyReceptor	getCasProxyReceptor()
ClientType	getClientType()
String	getEncoding()
LogoutHandler	getLogoutHandler()
long	getTimeTolerance()
protected void	initializeCas10Protocol()
protected void	initializeCas20Protocol(WebContext context)
protected void	initializeCas20ProxyProtocol(WebContext context)
protected void	initializeCas30Protocol(WebContext context)
protected void	initializeCas30ProxyProtocol(WebContext context)
protected void	initializeClientConfiguration()
protected void	initializeSAMLProtocol()
protected void	internalInit(WebContext context)
boolean	isAcceptAnyProxy()
protected boolean	isDirectRedirection()
boolean	isGateway()
boolean	isRenew()
protected IndirectClient<CasCredentials,CasProfile>	newClient()
protected CasCredentials	retrieveCredentials(WebContext context) Get the credentials from the web context.
protected RedirectAction	retrieveRedirectAction(WebContext context) Get the redirection url.
protected CasProfile	retrieveUserProfile(CasCredentials credentials, WebContext context) Get the user profile from the credentials.
void	setAcceptAnyProxy(boolean acceptAnyProxy)
void	setAllowedProxyChains(org.jasig.cas.client.validation.ProxyList allowedProxyChains)
void	setCasLoginUrl(String casLoginUrl)
void	setCasPrefixUrl(String casPrefixUrl)
void	setCasProtocol(CasClient.CasProtocol casProtocol)
void	setCasProxyReceptor(CasProxyReceptor casProxyReceptor)
void	setEncoding(String encoding)
void	setGateway(boolean gateway)
void	setLogoutHandler(LogoutHandler logoutHandler)
void	setRenew(boolean renew)
void	setTimeTolerance(long timeTolerance)
String	toString()

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

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

addAuthorizationGenerator, clone, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

SERVICE_PARAMETER

protected static final String SERVICE_PARAMETER

See Also:

Constant Field Values

SERVICE_TICKET_PARAMETER

public static final String SERVICE_TICKET_PARAMETER

See Also:

Constant Field Values

logoutHandler

protected LogoutHandler logoutHandler

ticketValidator

protected org.jasig.cas.client.validation.TicketValidator ticketValidator

encoding

protected String encoding

casLoginUrl

protected String casLoginUrl

casPrefixUrl

protected String casPrefixUrl

timeTolerance

protected long timeTolerance

casProtocol

protected CasClient.CasProtocol casProtocol

renew

protected boolean renew

gateway

protected boolean gateway

acceptAnyProxy

protected boolean acceptAnyProxy

allowedProxyChains

protected org.jasig.cas.client.validation.ProxyList allowedProxyChains

casProxyReceptor

protected CasProxyReceptor casProxyReceptor

Constructor Detail

CasClient

public CasClient()

CasClient

public CasClient(String casLoginUrl)

CasClient

public CasClient(String casLoginUrl,
                 CasClient.CasProtocol casProtocol)

CasClient

public CasClient(String casLoginUrl,
                 String casPrefixUrl)

Method Detail

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Get the redirection url.

Specified by:

retrieveRedirectAction in class IndirectClient<CasCredentials,CasProfile>

Parameters:

context - the web context

Returns:

the redirection url

newClient

protected IndirectClient<CasCredentials,CasProfile> newClient()

Specified by:

newClient in class BaseClient<CasCredentials,CasProfile>

internalInit

protected void internalInit(WebContext context)

Specified by:

internalInit in class InitializableWebObject

initializeSAMLProtocol

protected void initializeSAMLProtocol()

initializeCas30ProxyProtocol

protected void initializeCas30ProxyProtocol(WebContext context)

initializeCas30Protocol

protected void initializeCas30Protocol(WebContext context)

initializeCas20ProxyProtocol

protected void initializeCas20ProxyProtocol(WebContext context)

initializeCas20Protocol

protected void initializeCas20Protocol(WebContext context)

initializeCas10Protocol

protected void initializeCas10Protocol()

initializeClientConfiguration

protected void initializeClientConfiguration()

retrieveCredentials

protected CasCredentials retrieveCredentials(WebContext context)
                                      throws RequiresHttpAction

Get the credentials from the web context.

Specified by:

retrieveCredentials in class IndirectClient<CasCredentials,CasProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

RequiresHttpAction - requires an extra HTTP action

retrieveUserProfile

protected CasProfile retrieveUserProfile(CasCredentials credentials,
                                         WebContext context)

Get the user profile from the credentials.

Specified by:

retrieveUserProfile in class BaseClient<CasCredentials,CasProfile>

Parameters:

credentials - the CAS credentials

Returns:

the user profile

getCasLoginUrl

public String getCasLoginUrl()

setCasLoginUrl

public void setCasLoginUrl(String casLoginUrl)

getCasPrefixUrl

public String getCasPrefixUrl()

setCasPrefixUrl

public void setCasPrefixUrl(String casPrefixUrl)

getCasProtocol

public CasClient.CasProtocol getCasProtocol()

setCasProtocol

public void setCasProtocol(CasClient.CasProtocol casProtocol)

isRenew

public boolean isRenew()

setRenew

public void setRenew(boolean renew)

isGateway

public boolean isGateway()

setGateway

public void setGateway(boolean gateway)

getLogoutHandler

public LogoutHandler getLogoutHandler()

setLogoutHandler

public void setLogoutHandler(LogoutHandler logoutHandler)

isAcceptAnyProxy

public boolean isAcceptAnyProxy()

setAcceptAnyProxy

public void setAcceptAnyProxy(boolean acceptAnyProxy)

getAllowedProxyChains

public org.jasig.cas.client.validation.ProxyList getAllowedProxyChains()

setAllowedProxyChains

public void setAllowedProxyChains(org.jasig.cas.client.validation.ProxyList allowedProxyChains)

getCasProxyReceptor

public CasProxyReceptor getCasProxyReceptor()

setCasProxyReceptor

public void setCasProxyReceptor(CasProxyReceptor casProxyReceptor)

getTimeTolerance

public long getTimeTolerance()

setTimeTolerance

public void setTimeTolerance(long timeTolerance)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

toString

public String toString()

Overrides:

toString in class BaseClient<CasCredentials,CasProfile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class IndirectClient<CasCredentials,CasProfile>

getClientType

public ClientType getClientType()

Specified by:

getClientType in class BaseClient<CasCredentials,CasProfile>