Class HeaderExtractor
- java.lang.Object
-
- org.pac4j.core.credentials.extractor.HeaderExtractor
-
- All Implemented Interfaces:
CredentialsExtractor<TokenCredentials>
public class HeaderExtractor extends Object implements CredentialsExtractor<TokenCredentials>
To extract header value.- Since:
- 1.8.0
- Author:
- Jerome Leleu
-
-
Constructor Summary
Constructors Constructor Description HeaderExtractor()
HeaderExtractor(String headerName, String prefixHeader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<TokenCredentials>
extract(WebContext context)
Extract theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
if it cannot get it.String
getHeaderName()
String
getPrefixHeader()
boolean
isTrimValue()
void
setHeaderName(String headerName)
void
setPrefixHeader(String prefixHeader)
void
setTrimValue(boolean trimValue)
-
-
-
Method Detail
-
getHeaderName
public String getHeaderName()
-
setHeaderName
public void setHeaderName(String headerName)
-
getPrefixHeader
public String getPrefixHeader()
-
setPrefixHeader
public void setPrefixHeader(String prefixHeader)
-
isTrimValue
public boolean isTrimValue()
-
setTrimValue
public void setTrimValue(boolean trimValue)
-
extract
public Optional<TokenCredentials> extract(WebContext context)
Description copied from interface:CredentialsExtractor
Extract theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
if it cannot get it.- Specified by:
extract
in interfaceCredentialsExtractor<TokenCredentials>
- Parameters:
context
- the current web context- Returns:
- the credentials (optional)
-
-