Package org.pac4j.oidc.config

Class OidcConfiguration

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.config.BaseClientConfiguration

org.pac4j.oidc.config.OidcConfiguration

Direct Known Subclasses:

AppleOidcConfiguration, AzureAd2OidcConfiguration, KeycloakOidcConfiguration

public class OidcConfiguration
extends org.pac4j.core.client.config.BaseClientConfiguration

OpenID Connect configuration.

Since:

1.9.2

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final List<com.nimbusds.oauth2.sdk.ResponseType>	AUTHORIZATION_CODE_FLOWS
static final String	CLIENT_ID
static final String	CODE_CHALLENGE
static final String	CODE_CHALLENGE_METHOD
static final String	CUSTOM_PARAMS
static final int	DEFAULT_MAX_CLOCK_SKEW
static final int	DEFAULT_TOKEN_EXPIRATION_ADVANCE
static final List<com.nimbusds.oauth2.sdk.ResponseType>	HYBRID_CODE_FLOWS
static final List<com.nimbusds.oauth2.sdk.ResponseType>	IMPLICIT_FLOWS
static final String	MAX_AGE
static final String	NONCE
protected OidcOpMetadataResolver	opMetadataResolver
static final String	PROMPT
static final String	REDIRECT_URI
static final String	RESPONSE_MODE
static final String	RESPONSE_TYPE
static final String	SCOPE
static final String	STATE

Constructor Summary

Constructors

Constructor	Description
OidcConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addCustomParam(String key, String value)
void	configureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request)
String	findLogoutUrl()
com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod	findPkceMethod()
com.nimbusds.jose.util.ResourceRetriever	findResourceRetriever()
org.pac4j.core.logout.handler.SessionLogoutHandler	findSessionLogoutHandler()
String	getCustomParam(String name)
String	getResponseType()
int	getTokenExpirationAdvance()
protected void	internalInit(boolean forceReinit)
void	setClientAuthenticationMethodAsString(String auth)
void	setCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator)
void	setCustomParams(Map<String,String> customParams)
void	setDiscoveryURIIfUndefined(String discoveryURI)
void	setPreferredJwsAlgorithmAsString(String preferredJwsAlgorithm)
void	setResponseType(String responseType)
void	setStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator)
void	setValueRetriever(ValueRetriever valueRetriever)

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

afterInternalInit, beforeInternalInit, getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize, toString

Methods inherited from class java.lang.Object

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

Field Details

SCOPE

public static final String SCOPE

See Also:

• Constant Field Values

CUSTOM_PARAMS

public static final String CUSTOM_PARAMS

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

PROMPT

public static final String PROMPT

See Also:

• Constant Field Values

NONCE

public static final String NONCE

See Also:

• Constant Field Values

CODE_CHALLENGE

public static final String CODE_CHALLENGE

See Also:

• Constant Field Values

CODE_CHALLENGE_METHOD

public static final String CODE_CHALLENGE_METHOD

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

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

opMetadataResolver

protected OidcOpMetadataResolver opMetadataResolver

Constructor Details

OidcConfiguration

public OidcConfiguration()

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

internalInit in class org.pac4j.core.util.InitializableObject

setDiscoveryURIIfUndefined

public void setDiscoveryURIIfUndefined(String discoveryURI)

getCustomParam

public String getCustomParam(String name)

setCustomParams

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

addCustomParam

public void addCustomParam(String key,
 String value)

setClientAuthenticationMethodAsString

public void setClientAuthenticationMethodAsString(String auth)

findPkceMethod

public com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod findPkceMethod()

setPreferredJwsAlgorithmAsString

public void setPreferredJwsAlgorithmAsString(String preferredJwsAlgorithm)

configureHttpRequest

public void configureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request)

findResourceRetriever

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

setResponseType

public void setResponseType(String responseType)

findLogoutUrl

public String findLogoutUrl()

getTokenExpirationAdvance

public int getTokenExpirationAdvance()

setStateGenerator

public void setStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator)

setCodeVerifierGenerator

public void setCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator)

setValueRetriever

public void setValueRetriever(ValueRetriever valueRetriever)

findSessionLogoutHandler

public org.pac4j.core.logout.handler.SessionLogoutHandler findSessionLogoutHandler()

getResponseType

public String getResponseType()