Interface CredentialsExtractor
-
- All Known Implementing Classes:
BasicAuthExtractor
,BearerAuthExtractor
,FormExtractor
,HeaderExtractor
,ParameterExtractor
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface CredentialsExtractor
A credentials extractor.- Since:
- 1.8.0
- Author:
- Jerome Leleu
-
-
Method Summary
All Methods Instance Methods Abstract 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.
-
-
-
Method Detail
-
extract
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.- Parameters:
context
- the current web contextsessionStore
- the session store- Returns:
- the credentials (optional)
-
-