Class 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
    • 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.