org.ametys.plugins.repository.events

Class EventTypeExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<EventType>

org.ametys.plugins.repository.events.EventTypeExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<EventType>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class EventTypeExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<EventType>

This class is in charge of loading the various EventType. It also allows to communicate with them for the retrieval of events in JSON

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE The Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor and Description
EventTypeExtensionPoint()

Method Summary

Modifier and Type	Method and Description
void	addEvent(String eventId, Map<String,Object> parameters, EventHolder eventHolder) Add an event in the wanted event holder
List<Map<String,Object>>	getEvents(EventHolder eventHolder) Returns events of an event holder as JSON object
List<Map<String,Object>>	getEvents(EventHolder eventHolder, Set<String> eventIds) Returns events of an event holder as JSON object
List<Map<String,Object>>	getEvents(EventHolder eventHolder, Set<String> eventIds, int limit) Returns events of an event holder as JSON object
EventType	getEventType(String eventId) Returns the first EventType matching the provided event id
List<Map<String,Object>>	mergeEvents(List<Map<String,Object>> initialEvents) Merge events

Methods inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize, initializeExtensions, service

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon Role

Constructor Detail

EventTypeExtensionPoint

public EventTypeExtensionPoint()

Method Detail

addEvent

public void addEvent(String eventId,
                     Map<String,Object> parameters,
                     EventHolder eventHolder)
              throws RepositoryException

Add an event in the wanted event holder

Parameters:

eventId - the id of the event

parameters - the parameters of the event

eventHolder - the event holder node

Throws:

RepositoryException - if an exception occurs while manipulating the repository

getEvents

public List<Map<String,Object>> getEvents(EventHolder eventHolder)
                                   throws RepositoryException

Returns events of an event holder as JSON object

Parameters:

eventHolder - the event holder

Returns:

the events

Throws:

RepositoryException - if an exception occurs while manipulating the repository

getEvents

public List<Map<String,Object>> getEvents(EventHolder eventHolder,
                                          Set<String> eventIds)
                                   throws EventTypeProcessingException

Returns events of an event holder as JSON object

Parameters:

eventHolder - the event holder

eventIds - the event's types to retrieve. Can be null to retrieve all events.

Returns:

the events

Throws:

EventTypeProcessingException - if failed to get events

getEvents

public List<Map<String,Object>> getEvents(EventHolder eventHolder,
                                          Set<String> eventIds,
                                          int limit)
                                   throws EventTypeProcessingException

Returns events of an event holder as JSON object

Parameters:

eventHolder - the event holder

eventIds - the event's types to retrieve. Can be null to retrieve all events.

limit - The max number of events

Returns:

the events

Throws:

EventTypeProcessingException - if failed to get events

mergeEvents

public List<Map<String,Object>> mergeEvents(List<Map<String,Object>> initialEvents)

Merge events

Parameters:

initialEvents - The events to merge

Returns:

The merged events

getEventType

public EventType getEventType(String eventId)

Returns the first EventType matching the provided event id

Parameters:

eventId - the id of the event

Returns:

The event type