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,AzureAdOidcConfiguration,KeycloakOidcConfiguration
public class OidcConfiguration extends org.pac4j.core.client.config.BaseClientConfigurationOpenID Connect configuration.- Since:
- 1.9.2
- Author:
- Jerome Leleu
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.List<com.nimbusds.oauth2.sdk.ResponseType>AUTHORIZATION_CODE_FLOWSstatic java.lang.StringCLIENT_IDstatic java.lang.StringCODE_CHALLENGEstatic java.lang.StringCODE_CHALLENGE_METHODstatic java.lang.StringCUSTOM_PARAMSstatic intDEFAULT_MAX_CLOCK_SKEWstatic intDEFAULT_TOKEN_EXPIRATION_ADVANCEstatic java.util.List<com.nimbusds.oauth2.sdk.ResponseType>HYBRID_CODE_FLOWSstatic java.util.List<com.nimbusds.oauth2.sdk.ResponseType>IMPLICIT_FLOWSstatic java.lang.StringMAX_AGEstatic java.lang.StringNONCEstatic java.lang.StringPROMPTstatic java.lang.StringREDIRECT_URIstatic java.lang.StringRESPONSE_MODEstatic java.lang.StringRESPONSE_TYPEstatic java.lang.StringSCOPEstatic java.lang.StringSTATE
-
Constructor Summary
Constructors Constructor Description OidcConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCustomParam(java.lang.String key, java.lang.String value)voidconfigureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request)voiddefaultDiscoveryURI(java.lang.String discoveryURI)org.pac4j.core.logout.handler.LogoutHandlerfindLogoutHandler()java.lang.StringfindLogoutUrl()com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethodfindPkceMethod()com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadatafindProviderMetadata()com.nimbusds.jose.util.ResourceRetrieverfindResourceRetriever()TokenValidatorfindTokenValidator()com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethodgetClientAuthenticationMethod()java.lang.StringgetClientId()org.pac4j.core.util.generator.ValueGeneratorgetCodeVerifierGenerator()intgetConnectTimeout()java.lang.StringgetCustomParam(java.lang.String name)java.util.Map<java.lang.String,java.lang.String>getCustomParams()java.lang.StringgetDiscoveryURI()java.lang.StringgetLogoutUrl()java.util.Map<java.lang.String,java.lang.String>getMappedClaims()java.lang.IntegergetMaxAge()intgetMaxClockSkew()com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethodgetPkceMethod()com.nimbusds.jose.JWSAlgorithmgetPreferredJwsAlgorithm()com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadatagetProviderMetadata()intgetReadTimeout()com.nimbusds.jose.util.ResourceRetrievergetResourceRetriever()java.lang.StringgetResponseMode()java.lang.StringgetResponseType()java.lang.StringgetScope()java.lang.StringgetSecret()java.lang.StringgetSSLFactory()org.pac4j.core.util.generator.ValueGeneratorgetStateGenerator()intgetTokenExpirationAdvance()TokenValidatorgetTokenValidator()ValueRetrievergetValueRetriever()protected voidinternalInit(boolean forceReinit)booleanisAllowUnsignedIdTokens()booleanisDisablePkce()booleanisExpireSessionWithToken()booleanisIncludeAccessTokenClaimsInProfile()booleanisUseNonce()booleanisWithState()voidsetAllowUnsignedIdTokens(boolean allowUnsignedIdTokens)voidsetClientAuthenticationMethod(com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod clientAuthenticationMethod)voidsetClientAuthenticationMethodAsString(java.lang.String auth)voidsetClientId(java.lang.String clientId)voidsetCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator)voidsetConnectTimeout(int connectTimeout)voidsetCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)voidsetDisablePkce(boolean disablePkce)voidsetDiscoveryURI(java.lang.String discoveryURI)voidsetExpireSessionWithToken(boolean expireSessionWithToken)voidsetIncludeAccessTokenClaimsInProfile(boolean includeAccessTokenClaimsInProfile)voidsetLogoutHandler(org.pac4j.core.logout.handler.LogoutHandler logoutHandler)voidsetLogoutUrl(java.lang.String logoutUrl)voidsetMappedClaims(java.util.Map<java.lang.String,java.lang.String> mappedClaims)voidsetMaxAge(java.lang.Integer maxAge)voidsetMaxClockSkew(int maxClockSkew)voidsetPkceMethod(com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod pkceMethod)voidsetPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm)voidsetPreferredJwsAlgorithmAsString(java.lang.String preferredJwsAlgorithm)voidsetProviderMetadata(com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)voidsetReadTimeout(int readTimeout)voidsetResourceRetriever(com.nimbusds.jose.util.ResourceRetriever resourceRetriever)voidsetResponseMode(java.lang.String responseMode)voidsetResponseType(java.lang.String responseType)voidsetScope(java.lang.String scope)voidsetSecret(java.lang.String secret)voidsetSSLFactory(java.lang.String SSLFactory)voidsetStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator)voidsetTokenExpirationAdvance(int tokenExpirationAdvance)voidsetTokenValidator(TokenValidator tokenValidator)voidsetUseNonce(boolean useNonce)voidsetValueRetriever(ValueRetriever valueRetriever)voidsetWithState(boolean withState)java.lang.StringtoString()-
Methods inherited from class org.pac4j.core.util.InitializableObject
afterInternalInit, beforeInternalInit, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
-
-
-
Field Detail
-
SCOPE
public static final java.lang.String SCOPE
- See Also:
- Constant Field Values
-
CUSTOM_PARAMS
public static final java.lang.String CUSTOM_PARAMS
- See Also:
- Constant Field Values
-
RESPONSE_TYPE
public static final java.lang.String RESPONSE_TYPE
- See Also:
- Constant Field Values
-
RESPONSE_MODE
public static final java.lang.String RESPONSE_MODE
- See Also:
- Constant Field Values
-
REDIRECT_URI
public static final java.lang.String REDIRECT_URI
- See Also:
- Constant Field Values
-
CLIENT_ID
public static final java.lang.String CLIENT_ID
- See Also:
- Constant Field Values
-
STATE
public static final java.lang.String STATE
- See Also:
- Constant Field Values
-
MAX_AGE
public static final java.lang.String MAX_AGE
- See Also:
- Constant Field Values
-
PROMPT
public static final java.lang.String PROMPT
- See Also:
- Constant Field Values
-
NONCE
public static final java.lang.String NONCE
- See Also:
- Constant Field Values
-
CODE_CHALLENGE
public static final java.lang.String CODE_CHALLENGE
- See Also:
- Constant Field Values
-
CODE_CHALLENGE_METHOD
public static final java.lang.String CODE_CHALLENGE_METHOD
- See Also:
- Constant Field Values
-
AUTHORIZATION_CODE_FLOWS
public static final java.util.List<com.nimbusds.oauth2.sdk.ResponseType> AUTHORIZATION_CODE_FLOWS
-
IMPLICIT_FLOWS
public static final java.util.List<com.nimbusds.oauth2.sdk.ResponseType> IMPLICIT_FLOWS
-
HYBRID_CODE_FLOWS
public static final java.util.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
-
-
Method Detail
-
internalInit
protected void internalInit(boolean forceReinit)
- Specified by:
internalInitin classorg.pac4j.core.util.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 java.lang.String getClientId()
-
setClientId
public void setClientId(java.lang.String clientId)
-
getSecret
public java.lang.String getSecret()
-
setSecret
public void setSecret(java.lang.String secret)
-
getDiscoveryURI
public java.lang.String getDiscoveryURI()
-
defaultDiscoveryURI
public void defaultDiscoveryURI(java.lang.String discoveryURI)
-
getScope
public java.lang.String getScope()
-
setScope
public void setScope(java.lang.String scope)
-
getCustomParams
public java.util.Map<java.lang.String,java.lang.String> getCustomParams()
-
getCustomParam
public java.lang.String getCustomParam(java.lang.String name)
-
setCustomParams
public void setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)
-
addCustomParam
public void addCustomParam(java.lang.String key, java.lang.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(java.lang.String auth)
-
isUseNonce
public boolean isUseNonce()
-
setUseNonce
public void setUseNonce(boolean useNonce)
-
isDisablePkce
public boolean isDisablePkce()
-
setDisablePkce
public void setDisablePkce(boolean disablePkce)
-
findPkceMethod
public com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod findPkceMethod()
-
getPkceMethod
public com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod getPkceMethod()
-
setPkceMethod
public void setPkceMethod(com.nimbusds.oauth2.sdk.pkce.CodeChallengeMethod pkceMethod)
-
getPreferredJwsAlgorithm
public com.nimbusds.jose.JWSAlgorithm getPreferredJwsAlgorithm()
-
setPreferredJwsAlgorithm
public void setPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm)
-
setPreferredJwsAlgorithmAsString
public void setPreferredJwsAlgorithmAsString(java.lang.String preferredJwsAlgorithm)
-
getMaxAge
public java.lang.Integer getMaxAge()
-
setMaxAge
public void setMaxAge(java.lang.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)
-
configureHttpRequest
public void configureHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request)
-
getResourceRetriever
public com.nimbusds.jose.util.ResourceRetriever getResourceRetriever()
-
findResourceRetriever
public com.nimbusds.jose.util.ResourceRetriever findResourceRetriever()
-
setDiscoveryURI
public void setDiscoveryURI(java.lang.String discoveryURI)
-
setResourceRetriever
public void setResourceRetriever(com.nimbusds.jose.util.ResourceRetriever resourceRetriever)
-
getResponseType
public java.lang.String getResponseType()
-
setResponseType
public void setResponseType(java.lang.String responseType)
-
getResponseMode
public java.lang.String getResponseMode()
-
setResponseMode
public void setResponseMode(java.lang.String responseMode)
-
findLogoutUrl
public java.lang.String findLogoutUrl()
-
getLogoutUrl
public java.lang.String getLogoutUrl()
-
setLogoutUrl
public void setLogoutUrl(java.lang.String logoutUrl)
-
isWithState
public boolean isWithState()
-
setWithState
public void setWithState(boolean withState)
-
isExpireSessionWithToken
public boolean isExpireSessionWithToken()
-
setExpireSessionWithToken
public void setExpireSessionWithToken(boolean expireSessionWithToken)
-
getTokenExpirationAdvance
public int getTokenExpirationAdvance()
-
setTokenExpirationAdvance
public void setTokenExpirationAdvance(int tokenExpirationAdvance)
-
getStateGenerator
public org.pac4j.core.util.generator.ValueGenerator getStateGenerator()
-
setStateGenerator
public void setStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator)
-
getCodeVerifierGenerator
public org.pac4j.core.util.generator.ValueGenerator getCodeVerifierGenerator()
-
setCodeVerifierGenerator
public void setCodeVerifierGenerator(org.pac4j.core.util.generator.ValueGenerator codeVerifierGenerator)
-
getValueRetriever
public ValueRetriever getValueRetriever()
-
setValueRetriever
public void setValueRetriever(ValueRetriever valueRetriever)
-
findLogoutHandler
public org.pac4j.core.logout.handler.LogoutHandler findLogoutHandler()
-
setLogoutHandler
public void setLogoutHandler(org.pac4j.core.logout.handler.LogoutHandler logoutHandler)
-
getTokenValidator
public TokenValidator getTokenValidator()
-
setTokenValidator
public void setTokenValidator(TokenValidator tokenValidator)
-
findTokenValidator
public TokenValidator findTokenValidator()
-
getMappedClaims
public java.util.Map<java.lang.String,java.lang.String> getMappedClaims()
-
setMappedClaims
public void setMappedClaims(java.util.Map<java.lang.String,java.lang.String> mappedClaims)
-
isAllowUnsignedIdTokens
public boolean isAllowUnsignedIdTokens()
-
setAllowUnsignedIdTokens
public void setAllowUnsignedIdTokens(boolean allowUnsignedIdTokens)
-
isIncludeAccessTokenClaimsInProfile
public boolean isIncludeAccessTokenClaimsInProfile()
-
setIncludeAccessTokenClaimsInProfile
public void setIncludeAccessTokenClaimsInProfile(boolean includeAccessTokenClaimsInProfile)
-
getSSLFactory
public java.lang.String getSSLFactory()
-
setSSLFactory
public void setSSLFactory(java.lang.String SSLFactory)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-