Class HeaderExtractor
java.lang.Object
org.pac4j.core.credentials.extractor.HeaderExtractor
- All Implemented Interfaces:
CredentialsExtractor
To extract header value.
- Since:
- 1.8.0
- Author:
- Jerome Leleu
-
Constructor Summary
ConstructorDescriptionConstructor for HeaderExtractor.HeaderExtractor
(String headerName, String prefixHeader) Constructor for HeaderExtractor. -
Method Summary
Modifier and TypeMethodDescriptionextract
(CallContext ctx) Extract theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
if it cannot get it.Getter for the fieldheaderName
.Getter for the fieldprefixHeader
.boolean
isTrimValue.void
setHeaderName
(String headerName) Setter for the fieldheaderName
.void
setPrefixHeader
(String prefixHeader) Setter for the fieldprefixHeader
.void
setTrimValue
(boolean trimValue) Setter for the fieldtrimValue
.
-
Constructor Details
-
Method Details
-
getHeaderName
Getter for the field
headerName
.- Returns:
- a
String
object
-
setHeaderName
Setter for the field
headerName
.- Parameters:
headerName
- aString
object
-
getPrefixHeader
Getter for the field
prefixHeader
.- Returns:
- a
String
object
-
setPrefixHeader
Setter for the field
prefixHeader
.- Parameters:
prefixHeader
- aString
object
-
isTrimValue
public boolean isTrimValue()isTrimValue.
- Returns:
- a boolean
-
setTrimValue
public void setTrimValue(boolean trimValue) Setter for the field
trimValue
.- Parameters:
trimValue
- a boolean
-
extract
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:
ctx
- the current context- Returns:
- the credentials (optional)
-