Package com.attivio.sdk.ingest

Class Commit

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.ingest.AbstractIndexMessage

com.attivio.sdk.ingest.Commit

All Implemented Interfaces:

PlatformMessage, IndexMessage, java.io.Serializable, java.lang.Cloneable

public class Commit
extends AbstractIndexMessage

Signifies that the index or other underlying data store should commit currently held documents to disk.

The exact semantics of the commit are left up to the repository however a client should assume that after receiving the callback for this message that a given component is no longer holding onto any messages in a non-secure / memory only based store.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Commit.CommitMode	Mode for determining how the index will be optimized.

Field Summary

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor	Description
Commit()	The default constructor
Commit(java.util.UUID cid, WorkflowQueue workflows)	Constructor with a client ID and a workflow queue
Commit(java.util.UUID cid, java.lang.String... workflows)	Constructor with a client ID and an array of workflows

Method Summary

Modifier and Type	Method	Description
Commit	clone()	Clones the object and resets message ID to -1.
boolean	equals(java.lang.Object other)
Commit.CommitMode	getMode()	Get the mode for the commit operation.
java.util.List<java.lang.String>	getZones()	Expert: Get the list of zones to commit as part of this message.
int	hashCode()
void	setMode(Commit.CommitMode value)	Set the mode for the commit operation.
void	setZones(java.lang.String... value)	Expert: Set the list of zones to commit as part of this message.
void	setZones(java.util.List<java.lang.String> value)	Expert: Set the list of zones to commit as part of this message.

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.attivio.sdk.esb.PlatformMessage

addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getWorkflowQueue, getWorkflowQueue, isRedelivered, removeProperty, setClientId, setMessageId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString

Constructor Detail

Commit

public Commit()

The default constructor

Commit

public Commit(java.util.UUID cid,
              java.lang.String... workflows)

Constructor with a client ID and an array of workflows

Parameters:

cid - the client ID

workflows - the workflows

Commit

public Commit(java.util.UUID cid,
              WorkflowQueue workflows)

Constructor with a client ID and a workflow queue

Parameters:

cid -

workflows -

Method Detail

getMode

public Commit.CommitMode getMode()

Get the mode for the commit operation.

setMode

public void setMode(Commit.CommitMode value)

Set the mode for the commit operation.

getZones

public java.util.List<java.lang.String> getZones()

Expert: Get the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

setZones

public void setZones(java.util.List<java.lang.String> value)

Expert: Set the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

setZones

public void setZones(java.lang.String... value)

Expert: Set the list of zones to commit as part of this message.

If null or empty, then all zones will be committed.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPlatformMessage

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class AbstractPlatformMessage

clone

public Commit clone()

Clones the object and resets message ID to -1. Clones a message. The message ID is not cloned.

Specified by:

clone in interface IndexMessage

Specified by:

clone in interface PlatformMessage

Overrides:

clone in class AbstractIndexMessage

Returns:

the cloned index message