org.pac4j.oauth.config

Class OAuth20Configuration

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.oauth.config.OAuthConfiguration<com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

org.pac4j.oauth.config.OAuth20Configuration

Direct Known Subclasses:

FacebookConfiguration, LinkedIn2Configuration, OkConfiguration, VkConfiguration

public class OAuth20Configuration
extends OAuthConfiguration<com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

The OAuh 2.0 configuration.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OAUTH_CODE
static java.lang.String	STATE_REQUEST_PARAMETER

Fields inherited from class org.pac4j.oauth.config.OAuthConfiguration

OAUTH_TOKEN, RESPONSE_TYPE_CODE

Constructor Summary

Constructors

Constructor and Description
OAuth20Configuration()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getCustomParams()
java.lang.String	getStateData()
java.lang.String	getStateSessionAttributeName(java.lang.String clientName) Return the name of the attribute storing the state in session.
boolean	isWithState()
void	setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)
void	setStateData(java.lang.String stateData)
void	setWithState(boolean withState)

Methods inherited from class org.pac4j.oauth.config.OAuthConfiguration

buildService, getApi, getHasBeenCancelledFactory, getHttpClientConfig, getKey, getProfileDefinition, getResponseType, getScope, getSecret, internalInit, isTokenAsHeader, setApi, setHasBeenCancelledFactory, setHttpClientConfig, setKey, setProfileDefinition, setResponseType, setScope, setSecret, setTokenAsHeader, toString

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

init

Methods inherited from class java.lang.Object

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

Field Detail

OAUTH_CODE

public static final java.lang.String OAUTH_CODE

See Also:

Constant Field Values

STATE_REQUEST_PARAMETER

public static final java.lang.String STATE_REQUEST_PARAMETER

See Also:

Constant Field Values

Constructor Detail

OAuth20Configuration

public OAuth20Configuration()

Method Detail

getStateSessionAttributeName

public java.lang.String getStateSessionAttributeName(java.lang.String clientName)

Return the name of the attribute storing the state in session.

Parameters:

clientName - the client name

Returns:

the name of the attribute storing the state in session

getCustomParams

public java.util.Map<java.lang.String,java.lang.String> getCustomParams()

setCustomParams

public void setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)

isWithState

public boolean isWithState()

setWithState

public void setWithState(boolean withState)

getStateData

public java.lang.String getStateData()

setStateData

public void setStateData(java.lang.String stateData)