Package org.apache.zookeeper
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:
ZooKeeper.create(String, byte[], java.util.List, CreateMode),ZooKeeper.create(String, byte[], java.util.List, CreateMode, org.apache.zookeeper.AsyncCallback.StringCallback, Object),ZooKeeper.delete(String, int),ZooKeeper.setData(String, byte[], int),ZooKeeper.getData(String, boolean, Stat),ZooKeeper.getChildren(String, boolean)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOp.Checkstatic classOp.Createstatic classOp.CreateTTLstatic classOp.Deletestatic classOp.GetChildrenstatic classOp.GetDatastatic classOp.OpKindstatic classOp.SetData
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static Opcheck(String path, int version)Constructs an version check operation.static Opcreate(String path, byte[] data, List<ACL> acl, int flags)Constructs a create operation.static Opcreate(String path, byte[] data, List<ACL> acl, int flags, long ttl)Constructs a create operation.static Opcreate(String path, byte[] data, List<ACL> acl, CreateMode createMode)Constructs a create operation.static Opcreate(String path, byte[] data, List<ACL> acl, CreateMode createMode, long ttl)Constructs a create operation.static Opcreate(String path, byte[] data, CreateOptions options)Constructs a create operation which usesZooDefs.OpCode.create2if no one is inferred from create mode.static Opdelete(String path, int version)Constructs a delete operation.static OpgetChildren(String path)static OpgetData(String path)Op.OpKindgetKind()Gets the kind of an Op.StringgetPath()Gets the path for an Op.intgetType()Gets the integer type code for an Op.static OpsetData(String path, byte[] data, int version)Constructs an update operation.abstract RecordtoRequestRecord()Encodes an op for wire transmission.
-
-
-
Method Detail
-
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 nodedata- the initial data for the nodeacl- the acl for the nodeflags- specifying whether the node to be created is ephemeral and/or sequential but using the integer encoding.- See Also:
ZooKeeper.create(String, byte[], java.util.List, CreateMode),CreateMode.fromFlag(int)
-
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 nodedata- the initial data for the nodeacl- the acl for the nodeflags- 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:
ZooKeeper.create(String, byte[], java.util.List, CreateMode),CreateMode.fromFlag(int)
-
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 nodedata- the initial data for the nodeacl- the acl for the nodecreateMode- specifying whether the node to be created is ephemeral and/or sequential- See Also:
ZooKeeper.create(String, byte[], java.util.List, CreateMode)
-
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 nodedata- the initial data for the nodeacl- the acl for the nodecreateMode- specifying whether the node to be created is ephemeral and/or sequentialttl- optional ttl or 0 (createMode must imply a TTL)- See Also:
ZooKeeper.create(String, byte[], java.util.List, CreateMode)
-
create
public static Op create(String path, byte[] data, CreateOptions options)
Constructs a create operation which usesZooDefs.OpCode.create2if no one is inferred from create mode.The corresponding
OpResult.CreateResult.getStat()could be null if connected to server without this patch.- Parameters:
path- the path for the nodedata- the initial data for the nodeoptions- options for creating znode
-
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:
ZooKeeper.delete(String, int)
-
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 nodedata- the data to setversion- the expected matching version- See Also:
ZooKeeper.setData(String, byte[], int)
-
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 nodeversion- the expected matching version
-
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:
ZooDefs.OpCode
-
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.
-
-