org.pac4j.oidc.client

Class OidcClient<U extends OidcProfile>

java.lang.Object

org.pac4j.core.util.InitializableWebObject

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

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

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

All Implemented Interfaces:

Client<OidcCredentials,U>

Direct Known Subclasses:

AzureAdClient, GoogleOidcClient, KeycloakOidcClient

public class OidcClient<U extends OidcProfile>
extends IndirectClient<OidcCredentials,U>

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

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

logger

Constructor Summary

Constructors

Constructor and Description
OidcClient()
OidcClient(OidcConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context) Initialize the client.
OidcConfiguration	getConfiguration()
void	setConfiguration(OidcConfiguration configuration)
String	toString()

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver

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

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

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

init, reinit

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(OidcConfiguration configuration)

Method Detail

getConfiguration

public OidcConfiguration getConfiguration()

setConfiguration

public void setConfiguration(OidcConfiguration configuration)

clientInit

protected void clientInit(WebContext context)

Description copied from class: IndirectClient

Initialize the client.

Specified by:

clientInit in class IndirectClient<OidcCredentials,U extends OidcProfile>

Parameters:

context - the web context

toString

public String toString()

Overrides:

toString in class IndirectClient<OidcCredentials,U extends OidcProfile>