org.pac4j.oauth.credentials.extractor

Class OAuth20CredentialsExtractor

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.oauth.credentials.extractor.OAuth20CredentialsExtractor

All Implemented Interfaces:

CredentialsExtractor<OAuth20Credentials>

public class OAuth20CredentialsExtractor
extends InitializableWebObject

OAuth 2.0 credentials extractor.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected O	configuration
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
OAuth20CredentialsExtractor(OAuth20Configuration configuration)

Method Summary

Modifier and Type	Method and Description
C	extract(WebContext context) Extract the right credentials.
protected OAuth20Credentials	getOAuthCredentials(WebContext context) Get the OAuth credentials from the web context.
protected void	internalInit(WebContext context) Internal initialization of the object.
String	toString()

Methods inherited from class org.pac4j.core.util.InitializableWebObject

init, reinit

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

configuration

protected final O extends OAuthConfiguration configuration

Constructor Detail

OAuth20CredentialsExtractor

public OAuth20CredentialsExtractor(OAuth20Configuration configuration)

Method Detail

getOAuthCredentials

protected OAuth20Credentials getOAuthCredentials(WebContext context)
                                          throws HttpAction,
                                                 CredentialsException

Get the OAuth credentials from the web context.

Parameters:

context - the web context

Returns:

the OAuth credentials

Throws:

HttpAction - whether an additional HTTP action is required

CredentialsException - the credentials are invalid

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Specified by:

internalInit in class InitializableWebObject

Parameters:

context - the web context

extract

public C 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<C extends OAuthCredentials>

Parameters:

context - the current web context

Returns:

the credentials

Throws:

HttpAction - requires a specific HTTP action if necessary

CredentialsException - the credentials are invalid

toString

public String toString()

Overrides:

toString in class Object