org.pac4j.core.credentials.extractor

Interface CredentialsExtractor<C extends Credentials>

All Known Implementing Classes:

BasicAuthExtractor, CookieExtractor, DigestAuthExtractor, FormExtractor, HeaderExtractor, IpExtractor, OAuth10CredentialsExtractor, OAuth20CredentialsExtractor, OidcExtractor, ParameterExtractor, TicketAndLogoutRequestExtractor, YahooCredentialsExtractor

public interface CredentialsExtractor<C extends Credentials>

An extractor gets the Credentials from a WebContext and should return null if no credentials are present or should throw a CredentialsException if it cannot get it.

Since:

1.8.0

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method and Description
C	extract(WebContext context) Extract the right credentials.

Method Detail

extract

C extract(WebContext context)
   throws HttpAction,
          CredentialsException

Extract the right credentials. It should throw a CredentialsException in case of failure.

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid