Package org.pac4j.core.credentials.extractor

Class BasicAuthExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.BasicAuthExtractor

All Implemented Interfaces:

CredentialsExtractor

public class BasicAuthExtractor
extends Object
implements CredentialsExtractor

To extract basic auth header.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor	Description
BasicAuthExtractor()	Constructor for BasicAuthExtractor.
BasicAuthExtractor(String headerName, String prefixHeader)	Constructor for BasicAuthExtractor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicAuthExtractor

public BasicAuthExtractor()

Constructor for BasicAuthExtractor.

BasicAuthExtractor

public BasicAuthExtractor(String headerName,
 String prefixHeader)

Constructor for BasicAuthExtractor.

Parameters:

headerName - a String object

prefixHeader - a String object

Method Details

extract

public 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.

Specified by:

extract in interface CredentialsExtractor

Parameters:

ctx - the current context

Returns:

the credentials (optional)