Class Op

java.lang.Object
org.apache.zookeeper.Op
Direct Known Subclasses:
Op.Check, Op.Create, Op.Delete, Op.GetChildren, Op.GetData, Op.SetData

public abstract class Op extends Object
Represents a single operation in a multi-operation transaction. Each operation can be a create, update, delete, a version check or just read operations like getChildren or getData. Sub-classes of Op each represent each detailed type but should not normally be referenced except via the provided factory methods.
See Also:
  • Method Details

    • create

      public static Op create(String path, byte[] data, List<ACL> acl, int flags)
      Constructs a create operation. Arguments are as for the ZooKeeper method of the same name.
      Parameters:
      path - the path for the node
      data - the initial data for the node
      acl - the acl for the node
      flags - specifying whether the node to be created is ephemeral and/or sequential but using the integer encoding.
      See Also:
    • create

      public static Op create(String path, byte[] data, List<ACL> acl, int flags, long ttl)
      Constructs a create operation. Arguments are as for the ZooKeeper method of the same name but adding an optional ttl
      Parameters:
      path - the path for the node
      data - the initial data for the node
      acl - the acl for the node
      flags - specifying whether the node to be created is ephemeral and/or sequential but using the integer encoding.
      ttl - optional ttl or 0 (flags must imply a TTL creation mode)
      See Also:
    • create

      public static Op create(String path, byte[] data, List<ACL> acl, CreateMode createMode)
      Constructs a create operation. Arguments are as for the ZooKeeper method of the same name.
      Parameters:
      path - the path for the node
      data - the initial data for the node
      acl - the acl for the node
      createMode - specifying whether the node to be created is ephemeral and/or sequential
      See Also:
    • create

      public static Op create(String path, byte[] data, List<ACL> acl, CreateMode createMode, long ttl)
      Constructs a create operation. Arguments are as for the ZooKeeper method of the same name but adding an optional ttl
      Parameters:
      path - the path for the node
      data - the initial data for the node
      acl - the acl for the node
      createMode - specifying whether the node to be created is ephemeral and/or sequential
      ttl - optional ttl or 0 (createMode must imply a TTL)
      See Also:
    • delete

      public static Op delete(String path, int version)
      Constructs a delete operation. Arguments are as for the ZooKeeper method of the same name.
      Parameters:
      path - the path of the node to be deleted.
      version - the expected node version.
      See Also:
    • setData

      public static Op setData(String path, byte[] data, int version)
      Constructs an update operation. Arguments are as for the ZooKeeper method of the same name.
      Parameters:
      path - the path of the node
      data - the data to set
      version - the expected matching version
      See Also:
    • check

      public static Op check(String path, int version)
      Constructs an version check operation. Arguments are as for the ZooKeeper.setData method except that no data is provided since no update is intended. The purpose for this is to allow read-modify-write operations that apply to multiple znodes, but where some of the znodes are involved only in the read, not the write. A similar effect could be achieved by writing the same data back, but that leads to way more version updates than are necessary and more writing in general.
      Parameters:
      path - the path of the node
      version - the expected matching version
    • getChildren

      public static Op getChildren(String path)
    • getData

      public static Op getData(String path)
    • getType

      public int getType()
      Gets the integer type code for an Op. This code should be as from ZooDefs.OpCode
      Returns:
      The type code.
      See Also:
    • getPath

      public String getPath()
      Gets the path for an Op.
      Returns:
      The path.
    • getKind

      public Op.OpKind getKind()
      Gets the kind of an Op.
      Returns:
      The OpKind value.
    • toRequestRecord

      public abstract Record toRequestRecord()
      Encodes an op for wire transmission.
      Returns:
      An appropriate Record structure.