org.imixs.workflow.engine

Class EventLogService

java.lang.Object

org.imixs.workflow.engine.EventLogService

public class EventLogService
extends Object

The EventLogService is a service to create and access log events.

An event that occurs during an update or a processing function within a transaction becomes a fact when the transaction completes successfully. The EventLogService can be used to create this kind of "Change Data Capture" events. An example is the LuceneUpdateService, which should update the index of a document only if the document was successfully written to the database.

The service is bound to the current PersistenceContext and stores a defined type of document entity directly in the database to represent an event. These types of events can be queried by clients through the service.

Version:

1.0

Author:

rsoika

See Also:

UpdateService

Constructor Summary

Constructors

Constructor and Description
EventLogService()

Method Summary

Modifier and Type	Method and Description
EventLog	createEvent(String topic, String refID) Creates/updates a new event log entry.
EventLog	createEvent(String topic, String refID, ItemCollection document) Creates/updates a new event log entry.
EventLog	createEvent(String topic, String refID, Map<String,List<Object>> data) Creates/updates a new event log entry.
List<EventLog>	findEventsByRef(int maxCount, String ref, String... topic) Finds events for one or many given topics assigned to a given document reference ($uniqueId).
List<EventLog>	findEventsByTopic(int maxCount, String... topic) Finds events for one or many given topics
EventLog	getEvent(String id) Returns an detached event log entry by its ID.
void	removeEvent(EventLog _eventLog) Deletes an existing eventLog.
void	removeEvent(String id) Deletes an existing eventLog by its id.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventLogService

public EventLogService()

Method Detail

createEvent

public EventLog createEvent(String topic,
                            String refID)

Creates/updates a new event log entry.

Parameters:

refID - - uniqueid of the document to be assigned to the event

topic - - the topic of the event.

Returns:

- generated event log entry

createEvent

public EventLog createEvent(String topic,
                            String refID,
                            ItemCollection document)

Creates/updates a new event log entry.

Parameters:

refID - - uniqueId of the document to be assigned to the event

topic - - the topic of the event.

document - - optional document providing a data map

Returns:

- generated event log entry

createEvent

public EventLog createEvent(String topic,
                            String refID,
                            Map<String,List<Object>> data)

Creates/updates a new event log entry.

Parameters:

refID - - uniqueId of the document to be assigned to the event

topic - - the topic of the event.

data - - optional data map

Returns:

- generated event log entry

findEventsByTopic

public List<EventLog> findEventsByTopic(int maxCount,
                                        String... topic)

Finds events for one or many given topics

Parameters:

maxCount - - maximum count of events to be returned

topic - - list of topics

Returns:

- list of eventLogEntries

findEventsByRef

public List<EventLog> findEventsByRef(int maxCount,
                                      String ref,
                                      String... topic)

Finds events for one or many given topics assigned to a given document reference ($uniqueId). The method returns an empty list if no event log entries exist of the given refId,

Parameters:

maxCount - - maximum count of events to be returned

ref - - a reference ID for an assigned Document or Workitem instance

topic - - list of topics

Returns:

- list of eventLogEntries

removeEvent

public void removeEvent(EventLog _eventLog)

Deletes an existing eventLog. The method catches javax.persistence.OptimisticLockException as this may occur during parallel requests.

Parameters:

eventLog -

removeEvent

public void removeEvent(String id)

Deletes an existing eventLog by its id. The method catches javax.persistence.OptimisticLockException as this may occur during parallel requests.

Parameters:

eventLog -

getEvent

public EventLog getEvent(String id)

Returns an detached event log entry by its ID.

Parameters:

id - - id of the eventLog Entry

Returns:

detached eventLog entry or null if not found