Class FormExtractor
- java.lang.Object
-
- org.pac4j.core.credentials.extractor.FormExtractor
-
- All Implemented Interfaces:
CredentialsExtractor
public class FormExtractor extends java.lang.Object implements CredentialsExtractor
To extract a username and password posted from a form.- Since:
- 1.8.0
- Author:
- Jerome Leleu
-
-
Constructor Summary
Constructors Constructor Description FormExtractor(java.lang.String usernameParameter, java.lang.String passwordParameter)
-
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
getPasswordParameter()
java.lang.String
getUsernameParameter()
-
-
-
Method Detail
-
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)
-
getUsernameParameter
public java.lang.String getUsernameParameter()
-
getPasswordParameter
public java.lang.String getPasswordParameter()
-
-