org.keycloak.events.email

Class EmailEventListenerProvider

java.lang.Object

org.keycloak.events.email.EmailEventListenerProvider

All Implemented Interfaces:

EventListenerProvider, Provider

public class EmailEventListenerProvider
extends Object
implements EventListenerProvider

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor and Description
EmailEventListenerProvider(KeycloakSession session, EmailTemplateProvider emailTemplateProvider, Set<EventType> includedEvents)

Method Summary

Modifier and Type	Method and Description
void	close()
void	onEvent(AdminEvent event, boolean includeRepresentation) Called when an admin event occurs e.g.
void	onEvent(Event event) Called when a user event occurs e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailEventListenerProvider

public EmailEventListenerProvider(KeycloakSession session,
                                  EmailTemplateProvider emailTemplateProvider,
                                  Set<EventType> includedEvents)

Method Detail

onEvent

public void onEvent(Event event)

Description copied from interface: EventListenerProvider

Called when a user event occurs e.g. log in, register.

Note this method should not do any action that cannot be rolled back, see EventListenerProvider javadoc for more details.

Specified by:

onEvent in interface EventListenerProvider

Parameters:

event - to be triggered

onEvent

public void onEvent(AdminEvent event,
                    boolean includeRepresentation)

Description copied from interface: EventListenerProvider

Called when an admin event occurs e.g. a client was updated/deleted.

Note this method should not do any action that cannot be rolled back, see EventListenerProvider javadoc for more details.

Specified by:

onEvent in interface EventListenerProvider

Parameters:

event - to be triggered

includeRepresentation - when false, event listener should NOT include representation field in the resulting action

close

public void close()

Specified by:

close in interface Provider