Package org.imixs.melman

Class EventLogClient

java.lang.Object

org.imixs.melman.AbstractClient

org.imixs.melman.EventLogClient

public class EventLogClient
extends AbstractClient

This ServiceClient is a WebService REST Client which encapsulate the communication with Imixs EventLog REST service. The Implementation is based on the JAXB API 2.0.

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PAGE_SIZE
static final String	ITEM_ERROR_CODE
static final String	ITEM_ERROR_MESSAGE
protected int	pageIndex
protected int	pageSize

Fields inherited from class org.imixs.melman.AbstractClient

baseURI, requestFilterList, sslContext

Constructor Summary

Constructors

Constructor	Description
EventLogClient(String base_uri)	Initialize the client by a BASE_URL.

Method Summary

Modifier and Type	Method	Description
void	createEventLogEntry(String topic, String refID, org.imixs.workflow.ItemCollection document)	Creates a new topic for a given RefId by creating a PUT request
void	deleteEventLogEntry(String eventLogID)	Deletes a single workItem or document instance by UniqueID.
int	getPageIndex()
int	getPageSize()
void	lockEventLogEntry(String eventLogID)	Lock an EventLog entry by its ID.
void	releaseDeadLocks(long deadLockInterval, String... topic)	Lock an EventLog entry by its ID.
List<org.imixs.workflow.ItemCollection>	searchEventLog(String... topic)	Loads a collection of EventLog entries for a specific topic
void	setPageIndex(int pageIndex)
void	setPageSize(int pageSize)
void	unlockEventLogEntry(String eventLogID)	Lock an EventLog entry by its ID.

Methods inherited from class org.imixs.melman.AbstractClient

getBaseURI, getCustomResource, getCustomResourceXML, getRequestFilterList, getSslContext, getWebTarget, logout, newClient, registerClientRequestFilter, setBaseURI, setSslContext

Methods inherited from class java.lang.Object

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

Field Details

ITEM_ERROR_CODE

public static final String ITEM_ERROR_CODE

See Also:

• Constant Field Values

ITEM_ERROR_MESSAGE

public static final String ITEM_ERROR_MESSAGE

See Also:

• Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

• Constant Field Values

pageSize

protected int pageSize

pageIndex

protected int pageIndex

Constructor Details

EventLogClient

public EventLogClient(String base_uri)

Initialize the client by a BASE_URL.

Parameters:

base_uri -

Method Details

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getPageIndex

public int getPageIndex()

setPageIndex

public void setPageIndex(int pageIndex)

deleteEventLogEntry

public void deleteEventLogEntry(String eventLogID)
                         throws RestAPIException

Deletes a single workItem or document instance by UniqueID.

Parameters:

userid -

Throws:

RestAPIException

createEventLogEntry

public void createEventLogEntry(String topic,
 String refID,
 org.imixs.workflow.ItemCollection document)
                         throws RestAPIException

Creates a new topic for a given RefId by creating a PUT request

Parameters:

topic - - new topic

refID - - id of the document

document - - optional document data

Throws:

RestAPIException

lockEventLogEntry

public void lockEventLogEntry(String eventLogID)
                       throws RestAPIException

Lock an EventLog entry by its ID.

Parameters:

userid -

Throws:

RestAPIException

unlockEventLogEntry

public void unlockEventLogEntry(String eventLogID)
                         throws RestAPIException

Lock an EventLog entry by its ID.

Parameters:

userid -

Throws:

RestAPIException

releaseDeadLocks

public void releaseDeadLocks(long deadLockInterval,
 String... topic)
                      throws RestAPIException

Lock an EventLog entry by its ID.

Parameters:

userid -

Throws:

RestAPIException

searchEventLog

public List<org.imixs.workflow.ItemCollection> searchEventLog(String... topic)
                                                       throws RestAPIException

Loads a collection of EventLog entries for a specific topic

Parameters:

topic - - list of topics

Returns:

eventLog entries

Throws:

RestAPIException