ZkClient

Type Members

type ConnectResponseBehaviour = (ConnectResponse) ⇒ Future[Unit]

Definition Classes
ClientManager

Abstract Value Members

abstract val autoReconnect: Boolean
abstract val autoWatchReset: Boolean
abstract val canReadOnly: Boolean
abstract val chroot: String
abstract val dest: String
abstract val label: Option[String]
abstract val maxConsecutiveRetries: Int
abstract val maxReconnectAttempts: Int
abstract val sessionTimeout: Duration
abstract val timeBetweenAttempts: Duration
abstract val timeBetweenLinkCheck: Option[Duration]
abstract val timeBetweenPrevSrch: Option[Duration]
abstract val timeBetweenRwSrch: Option[Duration]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def addAuth(auth: Auth): Future[Unit]

Add the specified Auth(scheme:data) information to this connection.
Add the specified Auth(scheme:data) information to this connection.
auth
an Auth
returns
Future[Unit] or Exception
def addHosts(hostList: String): Unit

Should add some new servers to the host list
Should add some new servers to the host list
hostList
hosts to add

Definition Classes
ClientManager
final def asInstanceOf[T0]: T0

Definition Classes
Any
var authInfo: Set[Auth]

Attributes
protected[this]
def changeHost(host: Option[String] = None): Future[Unit]

Should try to connect to a new host if possible.
Should try to connect to a new host if possible. This operation will interrupt request sending until a new connection and a new session are established
host
the server to connect to
returns
Future.Done or Exception

Definition Classes
ClientManager
def checkWatcher(watcher: Watcher): Future[Unit]

Checks if a watcher event is still not triggered.
Checks if a watcher event is still not triggered.
watcher
a watcher to test
returns
Future[Unit] if the watcher is ok, or else ZooKeeperException
def checkWatches(path: String, watcherType: Int): Future[Unit]

Checks if the watches on a znode for this watcher type are not triggered on the server side.
Checks if the watches on a znode for this watcher type are not triggered on the server side.
path
the path to the znode
watcherType
the watcher type (children, data, any)
returns
Future[Unit] if the watches are ok, or else ZooKeeperException

Since
3.5.0
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(deadline: Time): Future[Unit]

Stops background jobs and closes the connection.
Stops background jobs and closes the connection. Should be used after closing the session.
deadline
a deadline for closing
returns
Future[Unit] or Exception

Definition Classes
ZkClient → Closable
def close(after: Duration): Future[Unit]

Definition Classes
Closable
final def close(): Future[Unit]

Definition Classes
Closable
def closeService(): Future[Unit]

Stops background jobs and closes the connection.
Stops background jobs and closes the connection. Should be used after closing the session.
returns
Future[Unit] or Exception
def closeSession(): Future[Unit]

Closes the session and stops background jobs.
Closes the session and stops background jobs.
returns
Future[Unit] or Exception
def connect(host: Option[String] = None): Future[Unit]

Connects to a host or finds an available server, then creates a session.
Connects to a host or finds an available server, then creates a session.
host
a server to connect to
returns
Future[Unit] or Exception
def create(path: String, data: Array[Byte], acl: Seq[ACL], createMode: Int): Future[String]

Create a node with the given path.
Create a node with the given path. The node data will be the given data, and node acl will be the given acl.
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
returns
Future[String] or Exception
def create2(path: String, data: Array[Byte], acl: Seq[ACL], createMode: Int): Future[Create2Response]

Create a node with the given path.
Create a node with the given path. The node data will be the given data, and node acl will be the given acl.
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
returns
Future[Create2Response] or Exception

Since
3.5.0
def delete(path: String, version: Int): Future[Unit]

Delete the node with the given path.
Delete the node with the given path. The call will succeed if such a node exists, and the given version matches the node's version (if the given version is -1, it matches any node's versions).
path
the path of the node to be deleted.
version
the expected node version.
returns
Future[Unit] or Exception
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exists(path: String, watch: Boolean = false): Future[ExistsResponse]

Return the stat of the node of the given path.
Return the stat of the node of the given path. Return null if no such a node exists.
If the watch is non-null and the call is successful (no exception is thrown), a watch will be left on the node with the given path. The watch will be triggered by a successful operation that creates/delete the node or sets the data on the node.
path
the node path
watch
a boolean to set a watch or not
returns
an ExistsReponse
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getACL(path: String): Future[GetACLResponse]

Return the ACL and stat of the node of the given path.
Return the ACL and stat of the node of the given path.
path
the node path
returns
Future[GetACLResponse] or Exception
def getChildren(path: String, watch: Boolean = false): Future[GetChildrenResponse]

For the given znode path return the stat and children list.
For the given znode path return the stat and children list.
If the watch is true and the call is successful (no exception is thrown), a watch will be left on the node with the given path. The watch will be triggered by a successful operation that deletes the node of the given path or creates/delete a child under the node.
path
the node path
watch
a boolean to set a watch or not
returns
Future[GetChildrenResponse] or Exception
def getChildren2(path: String, watch: Boolean = false): Future[GetChildren2Response]

For the given znode path return the stat and children list.
For the given znode path return the stat and children list.
If the watch is true and the call is successful (no exception is thrown), a watch will be left on the node with the given path. The watch will be triggered by a successful operation that deletes the node of the given path or creates/delete a child under the node.
path
the node path
watch
a boolean to set a watch or not
returns
Future[GetChildren2Response] or Exception
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getConfig(watch: Boolean = false): Future[GetDataResponse]

Return the last committed configuration (as known to the server to which the client is connected) and the stat of the configuration.
Return the last committed configuration (as known to the server to which the client is connected) and the stat of the configuration.
If the watch is true and the call is successful (no exception is thrown), a watch will be left on the configuration node. The watch will be triggered by a successful reconfig operation.
watch
set a watch or not
returns
configuration node data

Since
3.5.0
def getData(path: String, watch: Boolean = false): Future[GetDataResponse]

Return the data and the stat of the node of the given path.
Return the data and the stat of the node of the given path.
If the watch is non-null and the call is successful (no exception is thrown), a watch will be left on the node with the given path. The watch will be triggered by a successful operation that sets data on the node, or deletes the node.
path
the node path
watch
a boolean to set a watch or not
returns
Future[GetDataResponse] or Exception
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reconfig(joiningServers: String, leavingServers: String, newMembers: String, fromConfig: Long): Future[GetDataResponse]

Reconfigure - add/remove servers.
Reconfigure - add/remove servers. Return the new configuration.
joiningServers
a comma separated list of servers being added (incremental reconfiguration)
leavingServers
a comma separated list of servers being removed (incremental reconfiguration)
newMembers
a comma separated list of new membership (non-incremental reconfiguration)
fromConfig
version of the current configuration (optional - causes reconfiguration to throw an exception if configuration is no longer current)
returns
configuration node data

Since
3.5.0
def removeAllWatches(path: String, watcherType: Int, local: Boolean): Future[Unit]

For the given znode path, removes all the registered watchers of given watcherType.
For the given znode path, removes all the registered watchers of given watcherType.
path
the node path
watcherType
the watcher type (children, data, any)
local
whether watches can be removed locally when there is no server connection.
returns
Future[Unit]

Since
3.5.0
def removeHosts(hostList: String): Future[Unit]

Should remove some hosts from the host list
Should remove some hosts from the host list
hostList
hosts to remove
returns
Future.Done or Exception

Definition Classes
ClientManager
def removeWatches(watcher: Watcher, local: Boolean): Future[Unit]

For the given znode path, removes the specified watcher.
For the given znode path, removes the specified watcher.
watcher
the watcher to be removed
local
whether watches can be removed locally when there is no server connection.
returns
Future[Unit]

Since
3.5.0
def session: Session
def setACL(path: String, acl: Seq[ACL], version: Int): Future[Stat]

Set the ACL for the node of the given path if such a node exists and the given version matches the version of the node.
Set the ACL for the node of the given path if such a node exists and the given version matches the version of the node. Return the stat of the node.
path
the node path
acl
the ACLs to set
version
the node version
returns
the new znode stat
def setData(path: String, data: Array[Byte], version: Int): Future[Stat]

Set the data for the node of the given path if such a node exists and the given version matches the version of the node (if the given version is -1, it matches any node's versions).
Set the data for the node of the given path if such a node exists and the given version matches the version of the node (if the given version is -1, it matches any node's versions). Return the stat of the node.
This operation, if successful, will trigger all the watches on the node of the given path left by getData calls.
The maximum allowable size of the data array is 1 MB (1,048,576 bytes). Arrays larger than this will cause a ZooKeeperException to be thrown.
path
the node path
data
the data Array
version
the node version
returns
the new znode stat
def startRwSearch: Future[Unit]

Should start to search a RW mode server.
Should start to search a RW mode server.
returns
Future.Done

Definition Classes
ReadOnlyManager
def startStateLoop(): Unit

Start the loop which will check connection and session every timeBetweenLinkCheck
Start the loop which will check connection and session every timeBetweenLinkCheck

Definition Classes
AutoLinkManager
def stopRwSearch: Future[Unit]

Should stop Rw mode server search.
Should stop Rw mode server search.
returns
Future.Done

Definition Classes
ReadOnlyManager
def stopStateLoop(): Unit

Stop the state loop by cancelling its scheduler task
Stop the state loop by cancelling its scheduler task

Definition Classes
AutoLinkManager
def sync(path: String): Future[String]

Synchronize client and server for a node.
Synchronize client and server for a node.
path
the node path
returns
the synchronized znode's path
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transaction(opList: Seq[OpRequest]): Future[TransactionResponse]

Executes multiple ZooKeeper operations or none of them.
Executes multiple ZooKeeper operations or none of them.
On success, a list of results is returned. On failure, an exception is raised which contains partial results and error details. OpRequest: - CheckVersionRequest - CreateRequest - Create2Request (available in v3.5.0) - DeleteRequest - SetDataRequest
opList
a Sequence composed of OpRequest
returns
Future[TransactionResponse] or Exception
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
lazy val watcherManager: WatcherManager

trait ZkClient extends Closable with ClientManager

Type Members

type ConnectResponseBehaviour = (ConnectResponse) ⇒ Future[Unit]

Abstract Value Members

abstract val autoReconnect: Boolean

abstract val autoWatchReset: Boolean

abstract val canReadOnly: Boolean

abstract val chroot: String

abstract val dest: String

abstract val label: Option[String]

abstract val maxConsecutiveRetries: Int

abstract val maxReconnectAttempts: Int

abstract val sessionTimeout: Duration

abstract val timeBetweenAttempts: Duration

abstract val timeBetweenLinkCheck: Option[Duration]

abstract val timeBetweenPrevSrch: Option[Duration]

abstract val timeBetweenRwSrch: Option[Duration]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addAuth(auth: Auth): Future[Unit]

def addHosts(hostList: String): Unit

final def asInstanceOf[T0]: T0

var authInfo: Set[Auth]

def changeHost(host: Option[String] = None): Future[Unit]

def checkWatcher(watcher: Watcher): Future[Unit]

def checkWatches(path: String, watcherType: Int): Future[Unit]

def clone(): AnyRef

def close(deadline: Time): Future[Unit]

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

def closeService(): Future[Unit]

def closeSession(): Future[Unit]

def connect(host: Option[String] = None): Future[Unit]

def create(path: String, data: Array[Byte], acl: Seq[ACL], createMode: Int): Future[String]

def create2(path: String, data: Array[Byte], acl: Seq[ACL], createMode: Int): Future[Create2Response]

def delete(path: String, version: Int): Future[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(path: String, watch: Boolean = false): Future[ExistsResponse]

def finalize(): Unit

def getACL(path: String): Future[GetACLResponse]

def getChildren(path: String, watch: Boolean = false): Future[GetChildrenResponse]

def getChildren2(path: String, watch: Boolean = false): Future[GetChildren2Response]

final def getClass(): Class[_]

def getConfig(watch: Boolean = false): Future[GetDataResponse]

def getData(path: String, watch: Boolean = false): Future[GetDataResponse]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reconfig(joiningServers: String, leavingServers: String, newMembers: String, fromConfig: Long): Future[GetDataResponse]

def removeAllWatches(path: String, watcherType: Int, local: Boolean): Future[Unit]

def removeHosts(hostList: String): Future[Unit]

def removeWatches(watcher: Watcher, local: Boolean): Future[Unit]

def session: Session

def setACL(path: String, acl: Seq[ACL], version: Int): Future[Stat]

def setData(path: String, data: Array[Byte], version: Int): Future[Stat]

def startRwSearch: Future[Unit]

def startStateLoop(): Unit

def stopRwSearch: Future[Unit]

def stopStateLoop(): Unit

def sync(path: String): Future[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transaction(opList: Seq[OpRequest]): Future[TransactionResponse]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

lazy val watcherManager: WatcherManager

Inherited from ClientManager

Inherited from ReadOnlyManager

Inherited from AutoLinkManager

Inherited from Closable

Inherited from AnyRef