Package org.pac4j.core.credentials.extractor

Class HeaderExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.HeaderExtractor

All Implemented Interfaces:

CredentialsExtractor

public class HeaderExtractor
extends java.lang.Object
implements CredentialsExtractor

To extract header value.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.Optional<Credentials>	extract(WebContext context, SessionStore sessionStore)	Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.
java.lang.String	getHeaderName()
java.lang.String	getPrefixHeader()
boolean	isTrimValue()
void	setHeaderName(java.lang.String headerName)
void	setPrefixHeader(java.lang.String prefixHeader)
void	setTrimValue(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)

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)

isTrimValue

public boolean isTrimValue()

setTrimValue

public void setTrimValue(boolean trimValue)

extract

public java.util.Optional<Credentials> extract(WebContext context,
                                               SessionStore sessionStore)

Description copied from interface: CredentialsExtractor

Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Specified by:

extract in interface CredentialsExtractor

Parameters:

context - the current web context

sessionStore - the session store

Returns:

the credentials (optional)