Class ParameterExtractor
java.lang.Object
org.pac4j.core.credentials.extractor.ParameterExtractor
- All Implemented Interfaces:
CredentialsExtractor
To extract a parameter value.
- Since:
- 1.8.0
- Author:
- Jerome Leleu
-
Constructor Summary
ConstructorDescriptionParameterExtractor
(String parameterName) ParameterExtractor
(String parameterName, boolean supportGetRequest, boolean supportPostRequest) -
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.
-
Constructor Details
-
ParameterExtractor
-
ParameterExtractor
public ParameterExtractor(String parameterName, boolean supportGetRequest, boolean supportPostRequest)
-
-
Method Details
-
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)
-