Package org.pac4j.core.credentials.extractor

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

Modifier and Type	Method	Description
Optional<Credentials>	extract(CallContext ctx)	Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Method Details

extract

Optional<Credentials> extract(CallContext ctx)

Extract the Credentials from a WebContext and return Optional.empty() if no credentials are present or throw a CredentialsException if it cannot get it.

Parameters:

ctx - the current context

Returns:

the credentials (optional)