org.pac4j.http.client.direct

Class CookieClient

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

org.pac4j.http.client.direct.CookieClient

All Implemented Interfaces:

Client<TokenCredentials,CommonProfile>

public class CookieClient
extends DirectClientV2<TokenCredentials,CommonProfile>

Allows direct authentication based on a cookie.

Since:

1.8.0

Author:

Misagh Moayyed

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
CookieClient()
CookieClient(Authenticator cookieAuthenticator) Deprecated.
CookieClient(Authenticator cookieAuthenticator, ProfileCreator profileCreator) Deprecated.
CookieClient(String cookieName, Authenticator cookieAuthenticator)

Method Summary

Modifier and Type	Method and Description
String	getCookieName()
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setCookieName(String cookieName)

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

getAuthenticator, getCredentialsExtractor, getProfileCreator, retrieveCredentials, retrieveUserProfile, setAuthenticator, setCredentialsExtractor, setProfileCreator, toString

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

CookieClient

public CookieClient()

CookieClient

@Deprecated
public CookieClient(Authenticator cookieAuthenticator)

Deprecated.

CookieClient

public CookieClient(String cookieName,
                    Authenticator cookieAuthenticator)

CookieClient

@Deprecated
public CookieClient(Authenticator cookieAuthenticator,
                                ProfileCreator profileCreator)

Deprecated.

Method Detail

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

getCookieName

public String getCookieName()

setCookieName

public void setCookieName(String cookieName)