org.pac4j.cas.client

Class CasProxyReceptor

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.CasProxyReceptor

All Implemented Interfaces:

Client<CasCredentials,CasProfile>

public final class CasProxyReceptor
extends IndirectClient<CasCredentials,CasProfile>

This class is the CAS proxy receptor.

The url of the proxy receptor must be defined through the IndirectClient.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.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver

Constructor Summary

Constructors

Constructor and Description
CasProxyReceptor()

Method Summary

Modifier and Type	Method and Description
int	getMillisBetweenCleanUps()
org.jasig.cas.client.proxy.ProxyGrantingTicketStorage	getProxyGrantingTicketStorage()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected CasCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
protected RedirectAction	retrieveRedirectAction(WebContext context) Retrieve the redirect action.
protected CasProfile	retrieveUserProfile(CasCredentials credentials, WebContext context) Retrieve a user userprofile.
void	setMillisBetweenCleanUps(int millisBetweenCleanUps)
void	setProxyGrantingTicketStorage(org.jasig.cas.client.proxy.ProxyGrantingTicketStorage proxyGrantingTicketStorage)
String	toString()

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

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

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

addAuthorizationGenerator, 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

clone, 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

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class IndirectClient<CasCredentials,CasProfile>

Parameters:

context - the web context

retrieveRedirectAction

protected RedirectAction retrieveRedirectAction(WebContext context)
                                         throws HttpAction

Description copied from class: IndirectClient

Retrieve the redirect action.

Specified by:

retrieveRedirectAction in class IndirectClient<CasCredentials,CasProfile>

Parameters:

context - the web context

Returns:

the redirection action

Throws:

HttpAction - requires a specific HTTP action if necessary

retrieveCredentials

protected CasCredentials retrieveCredentials(WebContext context)
                                      throws HttpAction

Description copied from class: IndirectClient

Retrieve the credentials.

Specified by:

retrieveCredentials in class IndirectClient<CasCredentials,CasProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

retrieveUserProfile

protected CasProfile retrieveUserProfile(CasCredentials credentials,
                                         WebContext context)
                                  throws HttpAction

Description copied from class: BaseClient

Retrieve a user userprofile.

Specified by:

retrieveUserProfile in class BaseClient<CasCredentials,CasProfile>

Parameters:

credentials - the credentials

context - the web context

Returns:

the user profile

Throws:

HttpAction - whether an additional HTTP action is required

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>