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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<Credentials>
extract(WebContext context, SessionStore sessionStore)
Extract theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
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)
-
-
-
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 theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
if it cannot get it.- Specified by:
extract
in interfaceCredentialsExtractor
- Parameters:
context
- the current web contextsessionStore
- the session store- Returns:
- the credentials (optional)
-
-