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
FieldsModifier and TypeFieldDescriptionstatic final List<com.nimbusds.oauth2.sdk.ResponseType>ConstantAUTHORIZATION_CODE_FLOWSstatic final StringConstantCLIENT_ID="client_id"static final StringConstantCODE_CHALLENGE="code_challenge"static final StringConstantCODE_CHALLENGE_METHOD="code_challenge_method"static final StringConstantCUSTOM_PARAMS="custom_params"static final intConstantDEFAULT_MAX_CLOCK_SKEW=30static final intConstantDEFAULT_TOKEN_EXPIRATION_ADVANCE=0static final List<com.nimbusds.oauth2.sdk.ResponseType>ConstantHYBRID_CODE_FLOWSstatic final List<com.nimbusds.oauth2.sdk.ResponseType>ConstantIMPLICIT_FLOWSstatic final StringConstantMAX_AGE="max_age"static final StringConstantNONCE="nonce"protected OidcOpMetadataResolverstatic final StringConstantPROMPT="prompt"static final StringConstantREDIRECT_URI="redirect_uri"static final StringConstantRESPONSE_MODE="response_mode"static final StringConstantRESPONSE_TYPE="response_type"static final StringConstantSCOPE="scope"static final StringConstantSTATE="state" -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCustomParam(String key, String value) addCustomParam.voidconfigureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request) configureHttpRequest.findLogoutUrl.com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethodfindPkceMethod.com.nimbusds.jose.util.ResourceRetrieverfindResourceRetriever.getCustomParam(String name) getCustomParam.Getter for the fieldresponseType.intGetter for the fieldtokenExpirationAdvance.protected voidinternalInit(boolean forceReinit) voidsetClientAuthenticationMethodAsString.voidsetCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator) Setter for the fieldcodeVerifierGenerator.voidsetCustomParams(Map<String, String> customParams) Setter for the fieldcustomParams.voidsetDiscoveryURIIfUndefined(String discoveryURI) setDiscoveryURIIfUndefined.voidsetPreferredJwsAlgorithmAsString(String preferredJwsAlgorithm) setPreferredJwsAlgorithmAsString.voidsetResponseType(String responseType) Setter for the fieldresponseType.voidsetStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator) Setter for the fieldstateGenerator.voidsetValueRetriever(ValueRetriever valueRetriever) Setter for the fieldvalueRetriever.Methods inherited from class org.pac4j.core.util.InitializableObject
afterInternalInit, beforeInternalInit, getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize, toString
-
Field Details
-
SCOPE
ConstantSCOPE="scope"- See Also:
-
CUSTOM_PARAMS
ConstantCUSTOM_PARAMS="custom_params"- See Also:
-
RESPONSE_TYPE
ConstantRESPONSE_TYPE="response_type"- See Also:
-
RESPONSE_MODE
ConstantRESPONSE_MODE="response_mode"- See Also:
-
REDIRECT_URI
ConstantREDIRECT_URI="redirect_uri"- See Also:
-
CLIENT_ID
ConstantCLIENT_ID="client_id"- See Also:
-
STATE
ConstantSTATE="state"- See Also:
-
MAX_AGE
ConstantMAX_AGE="max_age"- See Also:
-
PROMPT
ConstantPROMPT="prompt"- See Also:
-
NONCE
ConstantNONCE="nonce"- See Also:
-
CODE_CHALLENGE
ConstantCODE_CHALLENGE="code_challenge"- See Also:
-
CODE_CHALLENGE_METHOD
ConstantCODE_CHALLENGE_METHOD="code_challenge_method"- See Also:
-
AUTHORIZATION_CODE_FLOWS
ConstantAUTHORIZATION_CODE_FLOWS -
IMPLICIT_FLOWS
ConstantIMPLICIT_FLOWS -
HYBRID_CODE_FLOWS
ConstantHYBRID_CODE_FLOWS -
DEFAULT_MAX_CLOCK_SKEW
public static final int DEFAULT_MAX_CLOCK_SKEWConstantDEFAULT_MAX_CLOCK_SKEW=30- See Also:
-
DEFAULT_TOKEN_EXPIRATION_ADVANCE
public static final int DEFAULT_TOKEN_EXPIRATION_ADVANCEConstantDEFAULT_TOKEN_EXPIRATION_ADVANCE=0- See Also:
-
opMetadataResolver
-
-
Constructor Details
-
OidcConfiguration
public OidcConfiguration()
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Specified by:
internalInitin classorg.pac4j.core.util.InitializableObject
-
setDiscoveryURIIfUndefined
setDiscoveryURIIfUndefined.
- Parameters:
discoveryURI- aStringobject
-
getCustomParam
getCustomParam.
-
setCustomParams
Setter for the field
customParams.- Parameters:
customParams- aMapobject
-
addCustomParam
addCustomParam.
-
setClientAuthenticationMethodAsString
setClientAuthenticationMethodAsString.
- Parameters:
auth- aStringobject
-
findPkceMethod
public com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod findPkceMethod()findPkceMethod.
- Returns:
- a
CodeChallengeMethodobject
-
setPreferredJwsAlgorithmAsString
setPreferredJwsAlgorithmAsString.
- Parameters:
preferredJwsAlgorithm- aStringobject
-
configureHttpRequest
public void configureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request) configureHttpRequest.
- Parameters:
request- aHTTPRequestobject
-
findResourceRetriever
public com.nimbusds.jose.util.ResourceRetriever findResourceRetriever()findResourceRetriever.
- Returns:
- a
ResourceRetrieverobject
-
setResponseType
Setter for the field
responseType.- Parameters:
responseType- aStringobject
-
findLogoutUrl
findLogoutUrl.
- Returns:
- a
Stringobject
-
getTokenExpirationAdvance
public int getTokenExpirationAdvance()Getter for the field
tokenExpirationAdvance.- Returns:
- a int
-
setStateGenerator
public void setStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator) Setter for the field
stateGenerator.- Parameters:
stateGenerator- aValueGeneratorobject
-
setCodeVerifierGenerator
public void setCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator) Setter for the field
codeVerifierGenerator.- Parameters:
codeVerifierGenerator- aValueGeneratorobject
-
setValueRetriever
Setter for the field
valueRetriever.- Parameters:
valueRetriever- aValueRetrieverobject
-
getResponseType
Getter for the field
responseType.- Returns:
- a
Stringobject
-