Package org.pac4j.oidc.client

Class OidcClient<V extends OidcConfiguration>

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<C>

org.pac4j.core.client.IndirectClient<OidcCredentials>

org.pac4j.oidc.client.OidcClient<V>

All Implemented Interfaces:

Client<OidcCredentials>

Direct Known Subclasses:

AppleClient, AzureAdClient, GoogleOidcClient, KeycloakOidcClient

public class OidcClient<V extends OidcConfiguration>
extends IndirectClient<OidcCredentials>

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

Constructor Summary

Constructors

Constructor	Description
OidcClient()
OidcClient(V configuration)

Method Summary

Modifier and Type	Method	Description
protected void	clientInit()
V	getConfiguration()
void	notifySessionRenewal(String oldSessionId, WebContext context)
Optional<UserProfile>	renewUserProfile(UserProfile profile, WebContext context)
void	setConfiguration(V configuration)
String	toString()

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

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

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

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

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

init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcClient

public OidcClient()

OidcClient

public OidcClient(V configuration)

Method Detail

getConfiguration

public V getConfiguration()

setConfiguration

public void setConfiguration(V configuration)

clientInit

protected void clientInit()

Specified by:

clientInit in class IndirectClient<OidcCredentials>

toString

public String toString()

Overrides:

toString in class IndirectClient<OidcCredentials>

renewUserProfile

public Optional<UserProfile> renewUserProfile(UserProfile profile,
                                              WebContext context)

Specified by:

renewUserProfile in interface Client<V extends OidcConfiguration>

Overrides:

renewUserProfile in class BaseClient<OidcCredentials>

notifySessionRenewal

public void notifySessionRenewal(String oldSessionId,
                                 WebContext context)

Overrides:

notifySessionRenewal in class BaseClient<OidcCredentials>