Package org.imixs.archive.service

Class RemoteAPIService

java.lang.Object

org.imixs.archive.service.RemoteAPIService

public class RemoteAPIService
extends Object

The RemoteService is used to access the remote API from the worklfow instance. All remote clients are based on the Imixs-Rest API.

To access the API the services uses the Imixs-Melman DocumentClient.

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static String	DOCUMENTS_RESOURCE
static String	SNAPSHOT_RESOURCE
static String	SNAPSHOT_SYNCPOINT_RESOURCE

Constructor Summary

Constructors

Constructor	Description
RemoteAPIService()

Method Summary

Modifier and Type	Method	Description
void	deleteSnapshot(String id)
String	readSnapshotIDByUniqueID(String uniqueid)	This method read the current snapshot id for a given UnqiueID.
org.imixs.workflow.xml.XMLDataCollection	readSyncData(long syncPoint)	This method read sync data.
void	restoreSnapshot(org.imixs.workflow.ItemCollection snapshot)

Methods inherited from class java.lang.Object

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

Field Detail

SNAPSHOT_RESOURCE

public static final String SNAPSHOT_RESOURCE

See Also:

Constant Field Values

DOCUMENTS_RESOURCE

public static final String DOCUMENTS_RESOURCE

See Also:

Constant Field Values

SNAPSHOT_SYNCPOINT_RESOURCE

public static final String SNAPSHOT_SYNCPOINT_RESOURCE

See Also:

Constant Field Values

Constructor Detail

RemoteAPIService

public RemoteAPIService()

Method Detail

readSyncData

public org.imixs.workflow.xml.XMLDataCollection readSyncData(long syncPoint)
                                                      throws ArchiveException

This method read sync data. The method returns the first workitem from the given syncpoint. If no data is available the method returns null.

Returns:

an XMLDataCollection instance representing the data to sync or null if no data form the given syncpoint is available.

Throws:

ArchiveException

readSnapshotIDByUniqueID

public String readSnapshotIDByUniqueID(String uniqueid)
                                throws ArchiveException

This method read the current snapshot id for a given UnqiueID. This information can be used to verify the sync satus of a single process instance.

Returns:

the current snapshotid

Throws:

ArchiveException

restoreSnapshot

public void restoreSnapshot(org.imixs.workflow.ItemCollection snapshot)
                     throws ArchiveException

Throws:

ArchiveException

deleteSnapshot

public void deleteSnapshot(String id)
                    throws ArchiveException

Throws:

ArchiveException