Package org.pac4j.oauth.config

Class OAuth20Configuration

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.config.BaseClientConfiguration

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, HiOrgServerConfiguration, 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	Description
static String	OAUTH_CODE
static String	STATE_REQUEST_PARAMETER

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

hasBeenCancelledFactory, httpClientConfig, key, OAUTH_TOKEN, profileDefinition, RESPONSE_TYPE_CODE, responseType, scope, secret, tokenAsHeader

Constructor Summary

Constructors

Constructor	Description
OAuth20Configuration()

Method Summary

Modifier and Type	Method	Description
com.github.scribejava.core.oauth.OAuth20Service	buildService(WebContext context, IndirectClient client)	Build an OAuth service from the web context.
com.github.scribejava.core.builder.api.DefaultApi20	getApi()
Map<String,String>	getCustomParams()
ValueGenerator	getStateGenerator()
protected void	internalInit()
boolean	isWithState()
void	setApi(com.github.scribejava.core.builder.api.DefaultApi20 api)
void	setCustomParams(Map<String,String> customParams)
void	setStateGenerator(ValueGenerator stateGenerator)
void	setWithState(boolean withState)
String	toString()

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

getHasBeenCancelledFactory, getHttpClientConfig, getKey, getProfileDefinition, getResponseType, getScope, getSecret, isTokenAsHeader, setHasBeenCancelledFactory, setHttpClientConfig, setKey, setProfileDefinition, setResponseType, setScope, setSecret, setTokenAsHeader

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

OAUTH_CODE

public static final String OAUTH_CODE

See Also:

Constant Field Values

STATE_REQUEST_PARAMETER

public static final String STATE_REQUEST_PARAMETER

See Also:

Constant Field Values

Constructor Detail

OAuth20Configuration

public OAuth20Configuration()

Method Detail

internalInit

protected void internalInit()

Overrides:

internalInit in class OAuthConfiguration<com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

buildService

public com.github.scribejava.core.oauth.OAuth20Service buildService(WebContext context,
                                                                    IndirectClient client)

Build an OAuth service from the web context.

Specified by:

buildService in class OAuthConfiguration<com.github.scribejava.core.oauth.OAuth20Service,com.github.scribejava.core.model.OAuth2AccessToken>

Parameters:

context - the web context

client - the client

Returns:

the OAuth service

getCustomParams

public Map<String,String> getCustomParams()

setCustomParams

public void setCustomParams(Map<String,String> customParams)

isWithState

public boolean isWithState()

setWithState

public void setWithState(boolean withState)

getStateGenerator

public ValueGenerator getStateGenerator()

setStateGenerator

public void setStateGenerator(ValueGenerator stateGenerator)

getApi

public com.github.scribejava.core.builder.api.DefaultApi20 getApi()

setApi

public void setApi(com.github.scribejava.core.builder.api.DefaultApi20 api)

toString

public String toString()

Overrides:

toString in class Object