org.pac4j.cas.client

Class CasProxyReceptor

java.lang.Object

org.pac4j.core.util.InitializableObject

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

org.pac4j.cas.client.CasProxyReceptor

All Implemented Interfaces:

Cloneable, Client<CasCredentials,CasProfile>

public final class CasProxyReceptor
extends BaseClient<CasCredentials,CasProfile>

This class is the CAS proxy receptor.

The url of the proxy receptor must be defined through the BaseClient.setCallbackUrl(String) method, it's the proxyReceptorUrl concept of the Jasig CAS client.

The proxy granting tickets and associations are stored by default in a ProxyGrantingTicketStorageImpl class, which can be overriden by using the setProxyGrantingTicketStorage(ProxyGrantingTicketStorage) method.

By default, the tickets and associations are cleaned every minute. The millisBetweenCleanUps property can be defined through the setMillisBetweenCleanUps(int) method (0 means no cleanup, greater than 0 means a cleanup every millisBetweenCleanUps milli-seconds).

Since:

1.4.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_PROXY_GRANTING_TICKET
static String	PARAM_PROXY_GRANTING_TICKET_IOU

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

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
CasProxyReceptor()

Method Summary

Modifier and Type	Method and Description
Mechanism	getMechanism()
int	getMillisBetweenCleanUps()
org.jasig.cas.client.proxy.ProxyGrantingTicketStorage	getProxyGrantingTicketStorage()
protected void	internalInit()
protected boolean	isDirectRedirection()
protected BaseClient<CasCredentials,CasProfile>	newClient()
protected CasCredentials	retrieveCredentials(WebContext context)
protected RedirectAction	retrieveRedirectAction(WebContext context)
protected CasProfile	retrieveUserProfile(CasCredentials credentials, WebContext context)
void	setMillisBetweenCleanUps(int millisBetweenCleanUps)
void	setProxyGrantingTicketStorage(org.jasig.cas.client.proxy.ProxyGrantingTicketStorage proxyGrantingTicketStorage)
String	toString()

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

addAuthorizationGenerator, clone, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getStateParameter, getUserProfile, isEnableContextualRedirects, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setName, setProfileCreator

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

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PROXY_GRANTING_TICKET_IOU

public static final String PARAM_PROXY_GRANTING_TICKET_IOU

See Also:

Constant Field Values

PARAM_PROXY_GRANTING_TICKET

public static final String PARAM_PROXY_GRANTING_TICKET

See Also:

Constant Field Values

Constructor Detail

CasProxyReceptor

public CasProxyReceptor()

Method Detail

newClient

protected BaseClient<CasCredentials,CasProfile> newClient()

Specified by:

newClient in class BaseClient<CasCredentials,CasProfile>

internalInit

protected void internalInit()

Specified by:

internalInit in class InitializableObject

retrieveCredentials

protected CasCredentials retrieveCredentials(WebContext context)
                                      throws RequiresHttpAction

Specified by:

retrieveCredentials in class BaseClient<CasCredentials,CasProfile>

Throws:

RequiresHttpAction

getProxyGrantingTicketStorage

public org.jasig.cas.client.proxy.ProxyGrantingTicketStorage getProxyGrantingTicketStorage()

setProxyGrantingTicketStorage

public void setProxyGrantingTicketStorage(org.jasig.cas.client.proxy.ProxyGrantingTicketStorage proxyGrantingTicketStorage)

getMillisBetweenCleanUps

public int getMillisBetweenCleanUps()

setMillisBetweenCleanUps

public void setMillisBetweenCleanUps(int millisBetweenCleanUps)

toString

public String toString()

Overrides:

toString in class BaseClient<CasCredentials,CasProfile>

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)

Specified by:

retrieveRedirectAction in class BaseClient<CasCredentials,CasProfile>

retrieveUserProfile

protected CasProfile retrieveUserProfile(CasCredentials credentials,
                                         WebContext context)

Specified by:

retrieveUserProfile in class BaseClient<CasCredentials,CasProfile>

isDirectRedirection

protected boolean isDirectRedirection()

Specified by:

isDirectRedirection in class BaseClient<CasCredentials,CasProfile>

getMechanism

public Mechanism getMechanism()

Specified by:

getMechanism in class BaseClient<CasCredentials,CasProfile>