org.pac4j.cas.client.direct

Class DirectCasClient

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

org.pac4j.core.client.DirectClientV2<TokenCredentials,CasProfile>

org.pac4j.cas.client.direct.DirectCasClient

All Implemented Interfaces:

Client<TokenCredentials,CasProfile>

public class DirectCasClient
extends DirectClientV2<TokenCredentials,CasProfile>

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 CasClient instead (this one is very specific and was designed for OAuth / OpenID Connect implementations in the CAS server.

The configuration can be defined via the configuration object.

As no session is meant to be created, this client does not handle CAS logout requests.

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

Author:

Jerome Leleu

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
DirectCasClient()
DirectCasClient(CasConfiguration casConfiguration)

Method Summary

Modifier and Type	Method and Description
CasConfiguration	getConfiguration()
protected void	internalInit(WebContext context) Internal initialization of the object.
protected TokenCredentials	retrieveCredentials(WebContext context) Retrieve the credentials.
void	setAuthenticator(Authenticator authenticator)
void	setConfiguration(CasConfiguration configuration)
String	toString()

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

getAuthenticator, getCredentialsExtractor, getProfileCreator, retrieveUserProfile, setCredentialsExtractor, setProfileCreator

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

getCredentials, redirect

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

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

Constructor Detail

DirectCasClient

public DirectCasClient()

DirectCasClient

public DirectCasClient(CasConfiguration casConfiguration)

Method Detail

retrieveCredentials

protected TokenCredentials retrieveCredentials(WebContext context)
                                        throws HttpAction

Description copied from class: BaseClient

Retrieve the credentials.

Overrides:

retrieveCredentials in class DirectClientV2<TokenCredentials,CasProfile>

Parameters:

context - the web context

Returns:

the credentials

Throws:

HttpAction - whether an additional HTTP action is required

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

getConfiguration

public CasConfiguration getConfiguration()

setConfiguration

public void setConfiguration(CasConfiguration configuration)

setAuthenticator

public void setAuthenticator(Authenticator authenticator)

Overrides:

setAuthenticator in class DirectClientV2<TokenCredentials,CasProfile>

toString

public String toString()

Overrides:

toString in class DirectClientV2<TokenCredentials,CasProfile>