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
-
Method Summary
Modifier and TypeMethodDescriptionextract
(WebContext context, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory) Extract theCredentials
from aWebContext
and returnOptional.empty()
if no credentials are present or throw aCredentialsException
if it cannot get it.boolean
void
setHeaderName
(String headerName) void
setPrefixHeader
(String prefixHeader) void
setTrimValue
(boolean trimValue)
-
Constructor Details
-
HeaderExtractor
public HeaderExtractor() -
HeaderExtractor
-
-
Method Details
-
getHeaderName
-
setHeaderName
-
getPrefixHeader
-
setPrefixHeader
-
isTrimValue
public boolean isTrimValue() -
setTrimValue
public void setTrimValue(boolean trimValue) -
extract
public Optional<Credentials> extract(WebContext context, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory) 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 storeprofileManagerFactory
- the profile manager factory- Returns:
- the credentials (optional)
-