Package org.pac4j.oidc.client
Class OidcClient
java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.oidc.client.OidcClient
- All Implemented Interfaces:
org.pac4j.core.client.Client
- Direct Known Subclasses:
AppleClient
,AzureAd2Client
,GoogleOidcClient
,KeycloakOidcClient
public class OidcClient
extends org.pac4j.core.client.IndirectClient
This class is the client to authenticate users with an OpenID Connect 1.0 provider.
By default, this implementation relies on the
"code" response type. (http://openid.net/specs/openid-connect-core-1_0.html).
- Since:
- 1.7.0
- Author:
- Michael Remond, Jerome Leleu
-
Field Summary
Fields inherited from class org.pac4j.core.client.IndirectClient
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver
Fields inherited from class org.pac4j.core.client.BaseClient
logger, saveProfileInSession
-
Constructor Summary
ConstructorDescriptionConstructor for OidcClient.OidcClient
(OidcConfiguration configuration) Constructor for OidcClient. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
beforeInternalInit
(boolean forceReinit) protected void
internalInit
(boolean forceReinit) void
notifySessionRenewal
(org.pac4j.core.context.CallContext ctx, String oldSessionId) Optional<org.pac4j.core.profile.UserProfile>
renewUserProfile
(org.pac4j.core.context.CallContext ctx, org.pac4j.core.profile.UserProfile profile) Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials
Methods inherited from class org.pac4j.core.util.InitializableObject
getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Constructor Details
-
OidcClient
public OidcClient()Constructor for OidcClient.
-
OidcClient
Constructor for OidcClient.
- Parameters:
configuration
- aOidcConfiguration
object
-
-
Method Details
-
beforeInternalInit
protected void beforeInternalInit(boolean forceReinit) - Overrides:
beforeInternalInit
in classorg.pac4j.core.client.IndirectClient
-
internalInit
protected void internalInit(boolean forceReinit) - Specified by:
internalInit
in classorg.pac4j.core.util.InitializableObject
-
renewUserProfile
public Optional<org.pac4j.core.profile.UserProfile> renewUserProfile(org.pac4j.core.context.CallContext ctx, org.pac4j.core.profile.UserProfile profile) - Specified by:
renewUserProfile
in interfaceorg.pac4j.core.client.Client
- Overrides:
renewUserProfile
in classorg.pac4j.core.client.BaseClient
-
notifySessionRenewal
- Overrides:
notifySessionRenewal
in classorg.pac4j.core.client.BaseClient
-