Package org.pac4j.oidc.config

Class OidcConfiguration

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.oidc.config.OidcConfiguration

Direct Known Subclasses:

AzureAdOidcConfiguration, KeycloakOidcConfiguration

public class OidcConfiguration
extends InitializableObject

OpenID Connect configuration.

Since:

1.9.2

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static List<com.nimbusds.oauth2.sdk.ResponseType>	AUTHORIZATION_CODE_FLOWS
static String	CLIENT_ID
static int	DEFAULT_MAX_CLOCK_SKEW
static int	DEFAULT_TOKEN_EXPIRATION_ADVANCE
static List<com.nimbusds.oauth2.sdk.ResponseType>	HYBRID_CODE_FLOWS
static List<com.nimbusds.oauth2.sdk.ResponseType>	IMPLICIT_FLOWS
static String	MAX_AGE
static String	NONCE
static String	NONCE_SESSION_ATTRIBUTE
static String	REDIRECT_URI
static String	RESPONSE_MODE
static String	RESPONSE_TYPE
static String	SCOPE
static String	STATE
static String	STATE_SESSION_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
OidcConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addCustomParam(String key, String value)
void	defaultDiscoveryURI(String discoveryURI)
com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	findProviderMetadata()
com.nimbusds.jose.util.ResourceRetriever	findResourceRetriever()
com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod	getClientAuthenticationMethod()
String	getClientId()
int	getConnectTimeout()
String	getCustomParam(String name)
Map<String,String>	getCustomParams()
String	getDiscoveryURI()
String	getLogoutUrl()
Integer	getMaxAge()
int	getMaxClockSkew()
com.nimbusds.jose.JWSAlgorithm	getPreferredJwsAlgorithm()
com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	getProviderMetadata()
int	getReadTimeout()
com.nimbusds.jose.util.ResourceRetriever	getResourceRetriever()
String	getResponseMode()
String	getResponseType()
String	getScope()
String	getSecret()
String	getStateData()	Deprecated.
StateGenerator	getStateGenerator()
int	getTokenExpirationAdvance()
protected void	internalInit()
boolean	isExpireSessionWithToken()
boolean	isUseNonce()
boolean	isWithState()
void	setClientAuthenticationMethod(com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod clientAuthenticationMethod)
void	setClientAuthenticationMethodAsString(String auth)
void	setClientId(String clientId)
void	setConnectTimeout(int connectTimeout)
void	setCustomParams(Map<String,String> customParams)
void	setDiscoveryURI(String discoveryURI)
void	setExpireSessionWithToken(boolean expireSessionWithToken)
void	setLogoutUrl(String logoutUrl)
void	setMaxAge(Integer maxAge)
void	setMaxClockSkew(int maxClockSkew)
void	setPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm)
void	setPreferredJwsAlgorithm(String preferredJwsAlgorithm)
void	setProviderMetadata(com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)
void	setReadTimeout(int readTimeout)
void	setResourceRetriever(com.nimbusds.jose.util.ResourceRetriever resourceRetriever)
void	setResponseMode(String responseMode)
void	setResponseType(String responseType)
void	setScope(String scope)
void	setSecret(String secret)
void	setStateData(String stateData)	Deprecated.
void	setStateGenerator(StateGenerator stateGenerator)
void	setTokenExpirationAdvance(int tokenExpirationAdvance)
void	setUseNonce(boolean useNonce)
void	setWithState(boolean withState)
String	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

SCOPE

public static final String SCOPE

See Also:

Constant Field Values

RESPONSE_TYPE

public static final String RESPONSE_TYPE

See Also:

Constant Field Values

RESPONSE_MODE

public static final String RESPONSE_MODE

See Also:

Constant Field Values

REDIRECT_URI

public static final String REDIRECT_URI

See Also:

Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

MAX_AGE

public static final String MAX_AGE

See Also:

Constant Field Values

NONCE

public static final String NONCE

See Also:

Constant Field Values

AUTHORIZATION_CODE_FLOWS

public static final List<com.nimbusds.oauth2.sdk.ResponseType> AUTHORIZATION_CODE_FLOWS

IMPLICIT_FLOWS

public static final List<com.nimbusds.oauth2.sdk.ResponseType> IMPLICIT_FLOWS

HYBRID_CODE_FLOWS

public static final List<com.nimbusds.oauth2.sdk.ResponseType> HYBRID_CODE_FLOWS

STATE_SESSION_ATTRIBUTE

public static final String STATE_SESSION_ATTRIBUTE

See Also:

Constant Field Values

NONCE_SESSION_ATTRIBUTE

public static final String NONCE_SESSION_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_MAX_CLOCK_SKEW

public static final int DEFAULT_MAX_CLOCK_SKEW

See Also:

Constant Field Values

DEFAULT_TOKEN_EXPIRATION_ADVANCE

public static final int DEFAULT_TOKEN_EXPIRATION_ADVANCE

See Also:

Constant Field Values

Constructor Detail

OidcConfiguration

public OidcConfiguration()

Method Detail

internalInit

protected void internalInit()

Specified by:

internalInit in class InitializableObject

getProviderMetadata

public com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata getProviderMetadata()

findProviderMetadata

public com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata findProviderMetadata()

setProviderMetadata

public void setProviderMetadata(com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

getDiscoveryURI

public String getDiscoveryURI()

defaultDiscoveryURI

public void defaultDiscoveryURI(String discoveryURI)

getScope

public String getScope()

setScope

public void setScope(String scope)

getCustomParams

public Map<String,String> getCustomParams()

getCustomParam

public String getCustomParam(String name)

setCustomParams

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

addCustomParam

public void addCustomParam(String key,
                           String value)

getClientAuthenticationMethod

public com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod getClientAuthenticationMethod()

setClientAuthenticationMethod

public void setClientAuthenticationMethod(com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod clientAuthenticationMethod)

setClientAuthenticationMethodAsString

public void setClientAuthenticationMethodAsString(String auth)

isUseNonce

public boolean isUseNonce()

setUseNonce

public void setUseNonce(boolean useNonce)

getPreferredJwsAlgorithm

public com.nimbusds.jose.JWSAlgorithm getPreferredJwsAlgorithm()

setPreferredJwsAlgorithm

public void setPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm)

setPreferredJwsAlgorithm

public void setPreferredJwsAlgorithm(String preferredJwsAlgorithm)

getMaxAge

public Integer getMaxAge()

setMaxAge

public void setMaxAge(Integer maxAge)

getMaxClockSkew

public int getMaxClockSkew()

setMaxClockSkew

public void setMaxClockSkew(int maxClockSkew)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

getResourceRetriever

public com.nimbusds.jose.util.ResourceRetriever getResourceRetriever()

findResourceRetriever

public com.nimbusds.jose.util.ResourceRetriever findResourceRetriever()

setDiscoveryURI

public void setDiscoveryURI(String discoveryURI)

setResourceRetriever

public void setResourceRetriever(com.nimbusds.jose.util.ResourceRetriever resourceRetriever)

getResponseType

public String getResponseType()

setResponseType

public void setResponseType(String responseType)

getResponseMode

public String getResponseMode()

setResponseMode

public void setResponseMode(String responseMode)

getLogoutUrl

public String getLogoutUrl()

setLogoutUrl

public void setLogoutUrl(String logoutUrl)

isWithState

public boolean isWithState()

setWithState

public void setWithState(boolean withState)

getStateData

@Deprecated
public String getStateData()

Deprecated.

setStateData

@Deprecated
public void setStateData(String stateData)

Deprecated.

isExpireSessionWithToken

public boolean isExpireSessionWithToken()

setExpireSessionWithToken

public void setExpireSessionWithToken(boolean expireSessionWithToken)

getTokenExpirationAdvance

public int getTokenExpirationAdvance()

setTokenExpirationAdvance

public void setTokenExpirationAdvance(int tokenExpirationAdvance)

getStateGenerator

public StateGenerator getStateGenerator()

setStateGenerator

public void setStateGenerator(StateGenerator stateGenerator)

toString

public String toString()

Overrides:

toString in class Object