org.pac4j.core.credentials.extractor

Class BasicAuthExtractor

java.lang.Object

org.pac4j.core.credentials.extractor.BasicAuthExtractor

All Implemented Interfaces:

CredentialsExtractor<UsernamePasswordCredentials>

public class BasicAuthExtractor
extends Object
implements CredentialsExtractor<UsernamePasswordCredentials>

To extract basic auth header.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
BasicAuthExtractor(String clientName)
BasicAuthExtractor(String headerName, String prefixHeader, String clientName)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthExtractor

public BasicAuthExtractor(String clientName)

BasicAuthExtractor

public BasicAuthExtractor(String headerName,
                          String prefixHeader,
                          String clientName)

Method Detail

extract

public UsernamePasswordCredentials extract(WebContext context)
                                    throws HttpAction,
                                           CredentialsException

Description copied from interface: CredentialsExtractor

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

Specified by:

extract in interface CredentialsExtractor<UsernamePasswordCredentials>

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid