org.pac4j.http.credentials.extractor

Class CookieExtractor

java.lang.Object

org.pac4j.http.credentials.extractor.CookieExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>

public class CookieExtractor
extends Object
implements CredentialsExtractor<TokenCredentials>

Extracts a cookie value from the request context.

Since:

1.8.0

Author:

Misagh Moayyed

Constructor Summary

Constructors

Constructor and Description
CookieExtractor(String cookieName)

Method Summary

Modifier and Type	Method and Description
TokenCredentials	extract(WebContext context) Extract the right credentials.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieExtractor

public CookieExtractor(String cookieName)

Method Detail

extract

public TokenCredentials extract(WebContext context)

Description copied from interface: CredentialsExtractor

Extract the right credentials. It should throw a CredentialsException in case of failure.

Specified by:

extract in interface CredentialsExtractor<TokenCredentials>

Parameters:

context - the current web context

Returns:

the credentials

toString

public String toString()

Overrides:

toString in class Object