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<C,U>

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

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

All Implemented Interfaces:

Client<OidcCredentials,U>

Direct Known Subclasses:

AzureAdClient, GoogleOidcClient

public class OidcClient<U extends OidcProfile>
extends IndirectClientV2<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, callbackUrlResolver

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

logger

Constructor Summary

Constructors

Constructor and Description
OidcClient()
OidcClient(OidcConfiguration oidcConfiguration)
OidcClient(String clientId, String secret, String discoveryURI) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addCustomParam(String key, String value) Deprecated.
protected void	createProfileCreator()
OidcConfiguration	getConfiguration()
protected void	internalInit(WebContext context) Internal initialization of the object.
void	setClientAuthenticationMethod(com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod clientAuthenticationMethod) Deprecated.
void	setClientID(String clientId) Deprecated.
void	setConfiguration(OidcConfiguration oidcConfiguration)
void	setCustomParams(Map<String,String> customParams) Deprecated.
void	setDiscoveryURI(String discoveryURI) Deprecated.
void	setPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm) Deprecated.
void	setScope(String scope) Deprecated.
void	setSecret(String secret) Deprecated.
void	setUseNonce(boolean useNonce) Deprecated.
String	toString()

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

getAuthenticator, getCredentialsExtractor, getProfileCreator, getRedirectActionBuilder, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, setAuthenticator, setCredentialsExtractor, setProfileCreator, setRedirectActionBuilder

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

computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl

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

addAuthorizationGenerator, addAuthorizationGenerators, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName

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 oidcConfiguration)

OidcClient

@Deprecated
public OidcClient(String clientId,
                              String secret,
                              String discoveryURI)

Deprecated.

Method Detail

getConfiguration

public OidcConfiguration getConfiguration()

setConfiguration

public void setConfiguration(OidcConfiguration oidcConfiguration)

setDiscoveryURI

@Deprecated
public void setDiscoveryURI(String discoveryURI)

Deprecated.

setClientID

@Deprecated
public void setClientID(String clientId)

Deprecated.

setSecret

@Deprecated
public void setSecret(String secret)

Deprecated.

setScope

@Deprecated
public void setScope(String scope)

Deprecated.

addCustomParam

@Deprecated
public void addCustomParam(String key,
                                       String value)

Deprecated.

setCustomParams

@Deprecated
public void setCustomParams(Map<String,String> customParams)

Deprecated.

internalInit

protected void internalInit(WebContext context)

Description copied from class: InitializableWebObject

Internal initialization of the object.

Overrides:

internalInit in class IndirectClient<OidcCredentials,U extends OidcProfile>

Parameters:

context - the web context

createProfileCreator

protected void createProfileCreator()

setPreferredJwsAlgorithm

@Deprecated
public void setPreferredJwsAlgorithm(com.nimbusds.jose.JWSAlgorithm preferredJwsAlgorithm)

Deprecated.

setUseNonce

@Deprecated
public void setUseNonce(boolean useNonce)

Deprecated.

setClientAuthenticationMethod

@Deprecated
public void setClientAuthenticationMethod(com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod clientAuthenticationMethod)

Deprecated.

toString

public String toString()

Overrides:

toString in class IndirectClientV2<OidcCredentials,U extends OidcProfile>