Package org.imixs.workflow.jaxrs

Class EventLogRestService

java.lang.Object

org.imixs.workflow.jaxrs.EventLogRestService

@Path("/eventlog")
@Produces({"application/xml","application/json","text/html","text/xml"})
public class EventLogRestService
extends Object

The EventLogRestService supports methods to access the event log entries by different kind of request URIs

Author:

rsoika

Constructor Summary

Constructors

Constructor	Description
EventLogRestService()

Method Summary

Modifier and Type	Method	Description
void	deleteEventLogEntry(String id)	Deletes a eventLog entry by its $uniqueID
org.imixs.workflow.xml.XMLDataCollection	getAllEventLogEntries(int pageSize, int pageIndex)	Returns all eventLog entries.
org.imixs.workflow.xml.XMLDataCollection	getEventLogEntriesByTopic(String topic, int maxCount)	Returns a set of eventLog entries for a given topic.
jakarta.ws.rs.core.Response	lockEventLogEntry(String id)	This method locks an eventLog entry for processing.
void	releaseDeadLocks(long deadLockInterval, String topic)	This method unlocks eventlog entries which are older than 1 minute.
jakarta.ws.rs.core.Response	unlockEventLogEntry(String id)	This method unlocks an eventLog entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventLogRestService

public EventLogRestService()

Method Detail

getAllEventLogEntries

@GET
@Path("/")
public org.imixs.workflow.xml.XMLDataCollection getAllEventLogEntries(@DefaultValue("100") @QueryParam("pageSize")
                                                                      int pageSize,
                                                                      @DefaultValue("0") @QueryParam("pageIndex")
                                                                      int pageIndex)

Returns all eventLog entries.

Parameters:

pageSize - - page size

pageIndex - - page index (default = 0)

items - - optional list of items

maxCount - - max count of returned eventLogEntries (default 99)

Returns:

result set.

getEventLogEntriesByTopic

@GET
@Path("/{topic}")
public org.imixs.workflow.xml.XMLDataCollection getEventLogEntriesByTopic(@PathParam("topic")
                                                                          String topic,
                                                                          @DefaultValue("99") @QueryParam("maxCount")
                                                                          int maxCount)

Returns a set of eventLog entries for a given topic. Multiple topics can be separated by a swung dash (~).

Parameters:

topic - - topic to search event log entries.

maxCount - - max count of returned eventLogEntries (default 99)

Returns:

- xmlDataCollection containing all matching eventLog entries

lockEventLogEntry

@POST
@Path("/lock/{id}")
public jakarta.ws.rs.core.Response lockEventLogEntry(@PathParam("id")
                                                     String id)

This method locks an eventLog entry for processing. The topic will be suffixed with '.lock' to indicate that this topic is locked by a process. If a lock is successful a client can exclusive process this eventLog entry.

Parameters:

id - - id of the event log entry

Returns:

the method returns a Response OK in case of a successful lock.

unlockEventLogEntry

@POST
@Path("/unlock/{id}")
public jakarta.ws.rs.core.Response unlockEventLogEntry(@PathParam("id")
                                                       String id)

This method unlocks an eventLog entry. The topic suffix '.lock' will be removed.

Parameters:

id - - id of the event log entry

releaseDeadLocks

@POST
@Path("/release/{interval}/{topic}")
public void releaseDeadLocks(@PathParam("interval")
                             long deadLockInterval,
                             @PathParam("topic")
                             String topic)

This method unlocks eventlog entries which are older than 1 minute. We assume that these events are deadlocks.

Parameters:

interval - - interval in millis

topic - - topic to search event log entries.

deleteEventLogEntry

@DELETE
@Path("/{id}")
public void deleteEventLogEntry(@PathParam("id")
                                String id)

Deletes a eventLog entry by its $uniqueID

Parameters:

name - of report or uniqueid