org.pac4j.core.credentials.extractor

Class HeaderExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.HeaderExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>

public class HeaderExtractor
extends java.lang.Object
implements CredentialsExtractor<TokenCredentials>

To extract header value.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
HeaderExtractor()
HeaderExtractor(java.lang.String headerName, java.lang.String prefixHeader, java.lang.String clientName)

Method Summary

Modifier and Type	Method and Description
TokenCredentials	extract(WebContext context) Extract the right credentials.
java.lang.String	getClientName()
java.lang.String	getHeaderName()
java.lang.String	getPrefixHeader()
java.lang.Boolean	getTrimValue()
void	setClientName(java.lang.String clientName)
void	setHeaderName(java.lang.String headerName)
void	setPrefixHeader(java.lang.String prefixHeader)
void	setTrimValue(java.lang.Boolean trimValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderExtractor

public HeaderExtractor()

HeaderExtractor

public HeaderExtractor(java.lang.String headerName,
                       java.lang.String prefixHeader,
                       java.lang.String clientName)

Method Detail

getHeaderName

public java.lang.String getHeaderName()

setHeaderName

public void setHeaderName(java.lang.String headerName)

getPrefixHeader

public java.lang.String getPrefixHeader()

setPrefixHeader

public void setPrefixHeader(java.lang.String prefixHeader)

getClientName

public java.lang.String getClientName()

setClientName

public void setClientName(java.lang.String clientName)

getTrimValue

public java.lang.Boolean getTrimValue()

setTrimValue

public void setTrimValue(java.lang.Boolean trimValue)

extract

public TokenCredentials extract(WebContext context)
                         throws HttpAction,
                                CredentialsException

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

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid