org.pac4j.oauth.config

Class OAuthConfiguration<C extends IndirectClient,S extends com.github.scribejava.core.oauth.OAuthService<?>,T extends com.github.scribejava.core.model.Token>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

org.pac4j.oauth.config.OAuthConfiguration<C,S,T>

Direct Known Subclasses:

OAuth10Configuration, OAuth20Configuration

public class OAuthConfiguration<C extends IndirectClient,S extends com.github.scribejava.core.oauth.OAuthService<?>,T extends com.github.scribejava.core.model.Token>
extends InitializableWebObject

The base OAuth configuration.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	OAUTH_TOKEN
static String	RESPONSE_TYPE_CODE
protected S	service

Constructor Summary

Constructors

Constructor and Description
OAuthConfiguration()

Method Summary

Modifier and Type	Method and Description
protected com.github.scribejava.core.model.OAuthConfig	buildOAuthConfig(WebContext context, String state)
S	buildService(WebContext context, String state) Build an OAuth service from the web context and with a state.
com.github.scribejava.core.builder.api.BaseApi<S>	getApi()
C	getClient()
int	getConnectTimeout() Deprecated.
java.util.function.Function<WebContext,Boolean>	getHasBeenCancelledFactory()
String	getKey()
OAuthProfileDefinition	getProfileDefinition()
int	getReadTimeout() Deprecated.
String	getResponseType()
String	getScope()
String	getSecret()
S	getService()
protected void	internalInit(WebContext context)
boolean	isHasGrantType()
boolean	isTokenAsHeader()
void	setApi(com.github.scribejava.core.builder.api.BaseApi<S> api)
void	setClient(C client)
void	setConnectTimeout(int connectTimeout) Deprecated.
void	setHasBeenCancelledFactory(java.util.function.Function<WebContext,Boolean> hasBeenCancelledFactory)
void	setHasGrantType(boolean hasGrantType)
void	setKey(String key)
void	setProfileDefinition(OAuthProfileDefinition profileDefinition)
void	setReadTimeout(int readTimeout) Deprecated.
void	setResponseType(String responseType)
void	setScope(String scope)
void	setSecret(String secret)
void	setTokenAsHeader(boolean tokenAsHeader)
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

OAUTH_TOKEN

public static final String OAUTH_TOKEN

See Also:

Constant Field Values

RESPONSE_TYPE_CODE

public static final String RESPONSE_TYPE_CODE

See Also:

Constant Field Values

service

protected S extends com.github.scribejava.core.oauth.OAuthService<?> service

Constructor Detail

OAuthConfiguration

public OAuthConfiguration()

Method Detail

internalInit

protected void internalInit(WebContext context)

Specified by:

internalInit in class InitializableWebObject

buildService

public S buildService(WebContext context,
                      String state)

Build an OAuth service from the web context and with a state.

Parameters:

context - the web context

state - a given state

Returns:

the OAuth service

buildOAuthConfig

protected com.github.scribejava.core.model.OAuthConfig buildOAuthConfig(WebContext context,
                                                                        String state)

getService

public S getService()

getClient

public C getClient()

setClient

public void setClient(C client)

getKey

public String getKey()

setKey

public void setKey(String key)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

isTokenAsHeader

public boolean isTokenAsHeader()

setTokenAsHeader

public void setTokenAsHeader(boolean tokenAsHeader)

getConnectTimeout

@Deprecated
public int getConnectTimeout()

Deprecated.

setConnectTimeout

@Deprecated
public void setConnectTimeout(int connectTimeout)

Deprecated.

getReadTimeout

@Deprecated
public int getReadTimeout()

Deprecated.

setReadTimeout

@Deprecated
public void setReadTimeout(int readTimeout)

Deprecated.

getResponseType

public String getResponseType()

setResponseType

public void setResponseType(String responseType)

getScope

public String getScope()

setScope

public void setScope(String scope)

getApi

public com.github.scribejava.core.builder.api.BaseApi<S> getApi()

setApi

public void setApi(com.github.scribejava.core.builder.api.BaseApi<S> api)

isHasGrantType

public boolean isHasGrantType()

setHasGrantType

public void setHasGrantType(boolean hasGrantType)

getHasBeenCancelledFactory

public java.util.function.Function<WebContext,Boolean> getHasBeenCancelledFactory()

setHasBeenCancelledFactory

public void setHasBeenCancelledFactory(java.util.function.Function<WebContext,Boolean> hasBeenCancelledFactory)

getProfileDefinition

public OAuthProfileDefinition getProfileDefinition()

setProfileDefinition

public void setProfileDefinition(OAuthProfileDefinition profileDefinition)

toString

public String toString()

Overrides:

toString in class Object