Package org.pac4j.core.credentials.extractor

Class BearerAuthExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.BearerAuthExtractor

All Implemented Interfaces:

CredentialsExtractor

public class BearerAuthExtractor
extends Object
implements CredentialsExtractor

To extract an RFC 6750 bearer auth header.

Since:

3.5.0

Author:

Graham Leggett

Constructor Summary

Constructors

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

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

BearerAuthExtractor

public BearerAuthExtractor()

Constructor for BearerAuthExtractor.

BearerAuthExtractor

public BearerAuthExtractor(String headerName,
 String prefixHeader)

Constructor for BearerAuthExtractor.

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)