org.keycloak.broker.provider

Class AbstractIdentityProvider<C extends IdentityProviderModel>

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProvider<C>

All Implemented Interfaces:

IdentityProvider<C>, Provider

public abstract class AbstractIdentityProvider<C extends IdentityProviderModel>
extends Object
implements IdentityProvider<C>

Author:

Pedro Igor

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.broker.provider.IdentityProvider

IdentityProvider.AuthenticationCallback

Constructor Summary

Constructors

Constructor and Description
AbstractIdentityProvider(C config)

Method Summary

Methods

Modifier and Type	Method and Description
void	attachUserSession(UserSessionModel userSession, ClientSessionModel clientSession, BrokeredIdentityContext context)
void	backchannelLogout(UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm)
Object	callback(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event) JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.
void	close()
javax.ws.rs.core.Response	export(javax.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format) Export a representation of the IdentityProvider in a specific format.
C	getConfig()
void	importNewUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)
javax.ws.rs.core.Response	keycloakInitiatedBrowserLogout(UserSessionModel userSession, javax.ws.rs.core.UriInfo uriInfo, RealmModel realm) Called when a Keycloak application initiates a logout through the browser.
void	preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, BrokeredIdentityContext context)
void	updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, BrokeredIdentityContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.broker.provider.IdentityProvider

performLogin, retrieveToken

Constructor Detail

AbstractIdentityProvider

public AbstractIdentityProvider(C config)

Method Detail

getConfig

public C getConfig()

export

public javax.ws.rs.core.Response export(javax.ws.rs.core.UriInfo uriInfo,
                               RealmModel realm,
                               String format)

Description copied from interface: IdentityProvider

Export a representation of the IdentityProvider in a specific format. For example, a SAML EntityDescriptor

Specified by:

export in interface IdentityProvider<C extends IdentityProviderModel>

Returns:

close

public void close()

Specified by:

close in interface Provider

callback

public Object callback(RealmModel realm,
              IdentityProvider.AuthenticationCallback callback,
              EventBuilder event)

Description copied from interface: IdentityProvider

JAXRS callback endpoint for when the remote IDP wants to callback to keycloak.

Specified by:

callback in interface IdentityProvider<C extends IdentityProviderModel>

Returns:

keycloakInitiatedBrowserLogout

public javax.ws.rs.core.Response keycloakInitiatedBrowserLogout(UserSessionModel userSession,
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       RealmModel realm)

Description copied from interface: IdentityProvider

Called when a Keycloak application initiates a logout through the browser. This is expected to do a logout with the IDP

Specified by:

keycloakInitiatedBrowserLogout in interface IdentityProvider<C extends IdentityProviderModel>

Returns:

null if this is not supported by this provider

backchannelLogout

public void backchannelLogout(UserSessionModel userSession,
                     javax.ws.rs.core.UriInfo uriInfo,
                     RealmModel realm)

Specified by:

backchannelLogout in interface IdentityProvider<C extends IdentityProviderModel>

attachUserSession

public void attachUserSession(UserSessionModel userSession,
                     ClientSessionModel clientSession,
                     BrokeredIdentityContext context)

Specified by:

attachUserSession in interface IdentityProvider<C extends IdentityProviderModel>

preprocessFederatedIdentity

public void preprocessFederatedIdentity(KeycloakSession session,
                               RealmModel realm,
                               BrokeredIdentityContext context)

Specified by:

preprocessFederatedIdentity in interface IdentityProvider<C extends IdentityProviderModel>

importNewUser

public void importNewUser(KeycloakSession session,
                 RealmModel realm,
                 UserModel user,
                 BrokeredIdentityContext context)

Specified by:

importNewUser in interface IdentityProvider<C extends IdentityProviderModel>

updateBrokeredUser

public void updateBrokeredUser(KeycloakSession session,
                      RealmModel realm,
                      UserModel user,
                      BrokeredIdentityContext context)

Specified by:

updateBrokeredUser in interface IdentityProvider<C extends IdentityProviderModel>