org.pac4j.oidc.client

Class KeycloakOidcClient

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<KeycloakOidcProfile>

org.pac4j.oidc.client.KeycloakOidcClient

All Implemented Interfaces:

Client<OidcCredentials,KeycloakOidcProfile>

public class KeycloakOidcClient
extends OidcClient<KeycloakOidcProfile>

This class is the OpenID Connect client to authenticate users in Keycloak.

A KeycloakOidcConfiguration is needed to create a client with to additional properties:

• baseUri : Base auth server url, e.g., https://keycloak.example.com/auth
• realm : keycloak realm

As seen in test case org.pac4j.oidc.run.RunKeycloakOidcClient

Since:

2.0.0

Author:

Julio Arrebola

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

Method Summary

Modifier and Type	Method and Description
protected void	clientInit(WebContext context) Initialize the client.

Methods inherited from class org.pac4j.oidc.client.OidcClient

getConfiguration, setConfiguration, 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

KeycloakOidcClient

public KeycloakOidcClient()

KeycloakOidcClient

public KeycloakOidcClient(OidcConfiguration configuration)

Method Detail

clientInit

protected void clientInit(WebContext context)

Description copied from class: IndirectClient

Initialize the client.

Overrides:

clientInit in class OidcClient<KeycloakOidcProfile>

Parameters:

context - the web context