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, AzureAdClient, 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

    Constructors
    Constructor
    Description
    OidcClient()
     
    OidcClient(OidcConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    beforeInternalInit(boolean forceReinit)
     
    OidcConfiguration
    getConfiguration()
     
    protected void
    internalInit(boolean forceReinit)
     
    void
    notifySessionRenewal(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
     
    Optional<org.pac4j.core.profile.UserProfile>
    renewUserProfile(org.pac4j.core.profile.UserProfile profile, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
     
    void
    setConfiguration(OidcConfiguration configuration)
     
    String
    toString()
     

    Methods inherited from class org.pac4j.core.client.IndirectClient

    afterInternalInit, computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver

    Methods inherited from class org.pac4j.core.client.BaseClient

    addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getUserProfile, isMultiProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession

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

    getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OidcClient

      public OidcClient()

    • OidcClient

      public OidcClient(OidcConfiguration configuration)

  • Method Details

    • beforeInternalInit

      protected void beforeInternalInit(boolean forceReinit)
      Overrides:
      beforeInternalInit in class org.pac4j.core.client.IndirectClient

    • internalInit

      protected void internalInit(boolean forceReinit)
      Specified by:
      internalInit in class org.pac4j.core.util.InitializableObject

    • renewUserProfile

      public Optional<org.pac4j.core.profile.UserProfile> renewUserProfile(org.pac4j.core.profile.UserProfile profile, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
      Specified by:
      renewUserProfile in interface org.pac4j.core.client.Client
      Overrides:
      renewUserProfile in class org.pac4j.core.client.BaseClient

    • notifySessionRenewal

      public void notifySessionRenewal(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore)
      Overrides:
      notifySessionRenewal in class org.pac4j.core.client.BaseClient

    • getConfiguration

      public OidcConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration(OidcConfiguration configuration)

    • toString

      public String toString()
      Overrides:
      toString in class org.pac4j.core.client.IndirectClient