com.loopfor.zookeeper

An ''access control list'' assignable to a ZooKeeper node.

Constructs and deconstructs ACL values.

The permissions assigned to an ACL are constructed by performing a bitwise union of individual permission attributes: Read, Write, Create, Delete, Admin. In addition, the All permission encompasses all of these attributes.

Several commonly used ACL values have been predefined for sake of convenience: AnyoneAll, AnyoneRead, CreatorAll.

Indicates any type of watch.

A state indicating that the session is in the process of associating.

A ZooKeeper client with ''asynchronous'' and ''watchable'' operations.

A ZooKeeper client with ''asynchronous'' operations.

Constructs AsynchronousZookeeper values.

This companion object is provided as a convenience and is equivalent to:

Zookeeper(...).async

An identity whose scheme is "auth" and id is "".

An event indicating that the client successfully authenticated with ZooKeeper.

An event indicating that the client failed to authenticate with ZooKeeper.

A state indicating that session authentication failed.

A ''check'' operation.

A problem with a ''check'' operation.

The result of a ''check'' operation.

An event indicating that a child watch was removed.

An event indicating that the children associated with a node were changed.

Indicates a watch for changes in children.

An event indicating that the client has closed its session with ZooKeeper.

A state indicating that the session has been closed.

A client ''configuration'' for connecting to a ZooKeeper cluster.

Constructs and deconstructs Configuration values.

A configuration is constructed by first specifying ''required'' attributes via Configuration() and then attaching ''optional'' attributes as necessary. A set of implicit methods conveniently convert between instances of Configuration and Builder.

Example:

val config = Configuration {
 ("foo.server.com", 2181) :: ("bar.server.com", 2181) :: Nil
} withTimeout {
 60 seconds
} withWatcher { (event, session) =>
 // ...
}

The type of config above is Builder since an implicit conversion occurred when attaching optional attributes using the various with methods. An explicit conversion back to Configuration, which can be accomplished using build(), is unnecessary since another implicit will perform this function automatically.

An event indicating that the client is connected to ZooKeeper.

An event indicating that the client is connected to ZooKeeper in a read-only manner.

A state indicating that the session is connected in read-only mode.

A state indicating that the session is connected.

A state indicating that the session is in the process of connecting.

Indicates that a node will be designated as a special purpose container useful for building higher-order constructs, such as leader election and locking.

The node will be eligible for deletion once all children have been deleted.

A ''create'' operation.

A problem with a ''create'' operation.

The result of a ''create'' operation.

An event indicating that a node was created.

A ''credential'' with a ZooKeeper session.

Constructs and deconstructs Credential values.

An event indicating that the data associated with a node was changed.

Indicates a watch for changes in data.

An event indicating that a data watch was removed.

A ''delete'' operation.

A problem with a ''delete'' operation.

The result of a ''delete'' operation.

An event indicating that a node was deleted.

An identity whose scheme is "digest" and id is equal to "[[username]]:[[password]]".

An event indicating that the client is not connected to ZooKeeper.

Specifies the disposition of nodes when created.

Indicates that a node will be automatically deleted when the creator disconnects from ZooKeeper.

Indicates that a node will be automatically deleted when the creator disconnects from ZooKeeper ''and'' that the name will be appended with a monotonically increasing number.

An ''event'' generated by ZooKeeper.

An event indicating that the client session has been expired by ZooKeeper.

An identity whose scheme is "host" and id is equal to "[[domain]]".

An ''identity'' associated with an ACL.

Constructs and deconstructs Id values.

An Id is composed of two parts: a scheme and an id. There exists only a finite set of ''schemes'' recognized by ZooKeeper, which are noted below. The acceptable form of ''id'' depends on the chosen scheme.

'''Schemes'''

world -- ''id'' must be "anyone".

auth -- ''id'' must be "" (empty string).

digest -- ''id'' must be of the form "''username'':''password''".

host -- ''id'' should be an Internet domain name.

ip -- ''id'' must be a valid IPv4 or IPv6 address with an optional network prefix, variations of which follow:

• "''addr''" where prefix is assumed to be 32 and 128 for IPv4 and IPv6, respectively.
• "''addr''/''prefix''" where prefix is in the range [0,32] and [0,128] for IPv4 and IPv6, respectively.

An identity whose scheme is "ip" and id is equal to "[[addr]]/[[prefix]]".

Represents a ''node'' in ZooKeeper.

Constructs and deconstructs Node values.

A category of events representing changes to nodes.

A state indicating that the session is not connected.

Specifies the type of watch that can be associated with a node.

An ''operation'' that may be composed with others to form an atomic transaction to ZooKeeper.

Represents an ''absolute'' or ''relative'' path to a node in ZooKeeper.

An ''absolute'' path starts with the / character. All other forms are considered ''relative''. Paths are virtually identical to those on Unix file systems and may include both . and .. parts, indicating the current and parent node, respectively.

Examples:

"/"
"../foo"
"/foo/bar"
"./foo/../bar"

Constructs and deconstructs Path values.

Indicates that a node will persist when the creator disconnects from ZooKeeper.

Indicates a persistent watch for changes in children and data.

A persistent watch is not automatically removed when triggered.

Indicates a persistent and recursive watch for changes in children and data.

A persistent watch is not automatically removed from triggered. The recursive nature means that the watch applies to all child nodes.

Indicates that a node will persist when the creator disconnects from ZooKeeper ''and'' that the name will be appended with a monotonically increasing number.

Indicates that a node will persist when the creator disconnects from ZooKeeper ''and'' that the name will be appended with a monotonically increasing number.

The node will be eligible for deletion if not modified within the given ''ttl'' and only after all its children have been deleted.

Constructs PersistentSequentialTimeToLive values.

Indicates that a node will persist when the creator disconnects from ZooKeeper.

The node will be eligible for deletion if not modified within the given ''ttl'' and only after all its children have been deleted.

Constructs PersistentTimeToLive values.

An event indicating that a persistent watch was removed.

A ''problem'' with an operation in the context of an atomic operation.

The ''result'' of an operation within an atomic transaction.

A ''session'' established with ZooKeeper.

Note that a session, particularly the life cycle, is managed by ZooKeeper servers, not the client. Under normal circumstances in which the client explicitly disconnects from the ZooKeeper cluster, its session is automatically expired. However, in cases where the client does not properly disconnect, ZooKeeper retains the session for a period of time defined by timeout.

Constructs and deconstructs Session values.

A ''set'' operation.

A problem with a ''set'' operation.

The result of a ''set'' operation.

The ''state'' of a ZooKeeper session.

A category of events representing state changes to sessions.

The ''status'' of a ZooKeeper node.

Each modification to ZooKeeper is stamped with a monotonically-increasing sequence number, known as a ''transaction id'' or ''zxid'', which conveys a total ordering of all changes. Thus, given any two changes, A and B, denoted by transaction ids, zxid,,A,, and zxid,,B,,, respectively, A is said to ''happen before'' B if zxid,,A,, < zxid,,B,,. Note that the ''transaction id'' is scoped to the entire ZooKeeper repository, not to individual nodes.

In addition to stamping all repository changes with a transaction id, which establishes total order, each modification to a given node also causes some ''version'' of that node to increment.

A ZooKeeper client with ''synchronous'' and ''watchable'' operations.

A ZooKeeper client with ''synchronous'' operations.

Constructs SynchronousZookeeper values.

This companion object is provided as a convenience and is equivalent to:

Zookeeper(...).sync

Specifies time-to-live for certain types of dispositions.

Constructs TimeToLive values.

An identity whose scheme is "world" and id is "anyone".

An instance of a ZooKeeper client.

Constructs Zookeeper values.

Converts the tuple (''host'',''port'') to an Internet socket address.