ZooKeeperMain (ZooKeeper 3.5.3-beta API)

java.lang.Object
+
- org.apache.zookeeper.ZooKeeperMain
+

+
+

public class ZooKeeperMain
+extends Object

The command line client to ZooKeeper.

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
ZooKeeperMain(String[] args)
ZooKeeperMain(ZooKeeper zk)
+

Constructors
Constructor and Description
`ZooKeeperMain(String[] args)`
`ZooKeeperMain(ZooKeeper zk)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`static boolean`	`createQuota(ZooKeeper zk, + String path, + long bytes, + int numNodes)` + this method creates a quota node for the path +
`static boolean`	`delQuota(ZooKeeper zk, + String path, + boolean bytes, + boolean numNodes)` + this method deletes quota for a node. +
`void`	`executeLine(String line)`
`static List<String>`	`getCommands()`
`boolean`	`getPrintWatches()`
`static void`	`main(String[] args)`
`static void`	`printMessage(String msg)`

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

Constructor Detail

+ + + +

ZooKeeperMain

public ZooKeeperMain(String[] args)
+              throws IOException,
+                     InterruptedException

Throws:: IOException; InterruptedException

+ + + +

+
ZooKeeperMain
+
```
public ZooKeeperMain(ZooKeeper zk)
```
+

+ +

+ + +

Method Detail

+ + + +

+
getPrintWatches
+
```
public boolean getPrintWatches()
```
+

+ + + +

getCommands

public static List<String> getCommands()

+ + + +

printMessage

public static void printMessage(String msg)

+ + + +

main

public static void main(String[] args)
+                 throws org.apache.zookeeper.cli.CliException,
+                        IOException,
+                        InterruptedException

Throws:: org.apache.zookeeper.cli.CliException; IOException; InterruptedException

+ + + +

executeLine

public void executeLine(String line)
+                 throws org.apache.zookeeper.cli.CliException,
+                        InterruptedException,
+                        IOException

Throws:: org.apache.zookeeper.cli.CliException; InterruptedException; IOException

+ + + +

delQuota

public static boolean delQuota(ZooKeeper zk,
+               String path,
+               boolean bytes,
+               boolean numNodes)
+                        throws KeeperException,
+                               IOException,
+                               InterruptedException

this method deletes quota for a node.

Parameters:: zk - the zookeeper client; path - the path to delete quota for; bytes - true if number of bytes needs to + be unset; numNodes - true if number of nodes needs + to be unset
Returns:: true if quota deletion is successful
Throws:: KeeperException; IOException; InterruptedException

+ + + +

createQuota

public static boolean createQuota(ZooKeeper zk,
+                  String path,
+                  long bytes,
+                  int numNodes)
+                           throws KeeperException,
+                                  IOException,
+                                  InterruptedException

this method creates a quota node for the path

Parameters:: zk - the ZooKeeper client; path - the path for which quota needs to be created; bytes - the limit of bytes on this path; numNodes - the limit of number of nodes on this path
Returns:: true if its successful and false if not.
Throws:: KeeperException; IOException; InterruptedException

java.lang.Object
+
- org.apache.zookeeper.ZooKeeper
- +
  - org.apache.zookeeper.admin.ZooKeeperAdmin
  +
+

+
+
All Implemented Interfaces:
+
AutoCloseable
+
+
+
+
```
public class ZooKeeperAdmin
+extends ZooKeeper
```
+
This is the main class for ZooKeeperAdmin client library. + This library is used to perform cluster administration tasks, + such as reconfigure cluster membership. The ZooKeeperAdmin class + inherits ZooKeeper and has similar usage pattern as ZooKeeper class. + Please check ZooKeeper class document for more details.
+
Since:
+
3.5.3
+

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from class org.apache.zookeeper.ZooKeeper
  +ZooKeeper.States, ZooKeeper.WatchRegistration
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.zookeeper.ZooKeeper
  +SECURE_CLIENT, ZOOKEEPER_CLIENT_CNXN_SOCKET
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`ZooKeeperAdmin(String connectString, + int sessionTimeout, + Watcher watcher)` + Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations. +
`ZooKeeperAdmin(String connectString, + int sessionTimeout, + Watcher watcher, + boolean canBeReadOnly)` + Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations. +
`ZooKeeperAdmin(String connectString, + int sessionTimeout, + Watcher watcher, + org.apache.zookeeper.client.ZKClientConfig conf)` + Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`void`	`reconfigure(List<String> joiningServers, + List<String> leavingServers, + List<String> newMembers, + long fromConfig, + AsyncCallback.DataCallback cb, + Object ctx)` + Convenience wrapper around asynchronous reconfig that takes Lists of strings instead of comma-separated servers. +
`byte[]`	`reconfigure(List<String> joiningServers, + List<String> leavingServers, + List<String> newMembers, + long fromConfig, + Stat stat)` + Convenience wrapper around reconfig that takes Lists of strings instead of comma-separated servers. +
`void`	`reconfigure(String joiningServers, + String leavingServers, + String newMembers, + long fromConfig, + AsyncCallback.DataCallback cb, + Object ctx)` + The Asynchronous version of reconfig. +
`byte[]`	`reconfigure(String joiningServers, + String leavingServers, + String newMembers, + long fromConfig, + Stat stat)` + Reconfigure - add/remove servers. +
`String`	`toString()` + String representation of this ZooKeeperAdmin client. +

+ + +
Methods inherited from class org.apache.zookeeper.ZooKeeper
+addAuthInfo, close, create, create, create, create, create, create, delete, delete, exists, exists, exists, exists, getACL, getACL, getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getChildren, getClientConfig, getConfig, getConfig, getConfig, getConfig, getData, getData, getData, getData, getSaslClient, getSessionId, getSessionPasswd, getSessionTimeout, getState, getTestable, multi, multi, reconfig, reconfig, reconfig, reconfig, register, removeAllWatches, removeAllWatches, removeWatches, removeWatches, setACL, setACL, setData, setData, sync, transaction, updateServerList

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ZooKeeperAdmin
    +
```
public ZooKeeperAdmin(String connectString,
+              int sessionTimeout,
+              Watcher watcher)
+               throws IOException
```
    +
    Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations.
    +
    Parameters:
    connectString - comma separated host:port pairs, each corresponding to a zk + server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If + the optional chroot suffix is used the example would look + like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" + where the client would be rooted at "/app/a" and all paths + would be relative to this root - ie getting/setting/etc... + "/foo/bar" would result in operations being run on + "/app/a/foo/bar" (from the server perspective).
    sessionTimeout - session timeout in milliseconds
    watcher - a watcher object which will be notified of state changes, may + also be notified for node events
    +
    Throws:
    +
    IOException - in cases of network failure
    +
    IllegalArgumentException - if an invalid chroot path is specified
    See Also:
    ZooKeeper.ZooKeeper(String, int, Watcher)
    +
  + + + +
  - +
    ZooKeeperAdmin
    +
```
public ZooKeeperAdmin(String connectString,
+              int sessionTimeout,
+              Watcher watcher,
+              org.apache.zookeeper.client.ZKClientConfig conf)
+               throws IOException
```
    +
    Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations.
    +
    Parameters:
    connectString - comma separated host:port pairs, each corresponding to a zk + server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If + the optional chroot suffix is used the example would look + like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" + where the client would be rooted at "/app/a" and all paths + would be relative to this root - ie getting/setting/etc... + "/foo/bar" would result in operations being run on + "/app/a/foo/bar" (from the server perspective).
    sessionTimeout - session timeout in milliseconds
    watcher - a watcher object which will be notified of state changes, may + also be notified for node events
    conf - passing this conf object gives each client the flexibility of + configuring properties differently compared to other instances
    +
    Throws:
    +
    IOException - in cases of network failure
    +
    IllegalArgumentException - if an invalid chroot path is specified
    See Also:
    ZooKeeper.ZooKeeper(String, int, Watcher, ZKClientConfig)
    +
  + + + +
  - +
    ZooKeeperAdmin
    +
```
public ZooKeeperAdmin(String connectString,
+              int sessionTimeout,
+              Watcher watcher,
+              boolean canBeReadOnly)
+               throws IOException
```
    +
    Create a ZooKeeperAdmin object which is used to perform dynamic reconfiguration + operations.
    +
    Parameters:
    connectString - comma separated host:port pairs, each corresponding to a zk + server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If + the optional chroot suffix is used the example would look + like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" + where the client would be rooted at "/app/a" and all paths + would be relative to this root - ie getting/setting/etc... + "/foo/bar" would result in operations being run on + "/app/a/foo/bar" (from the server perspective).
    sessionTimeout - session timeout in milliseconds
    watcher - a watcher object which will be notified of state changes, may + also be notified for node events
    canBeReadOnly - whether the created client is allowed to go to + read-only mode in case of partitioning. Read-only mode + basically means that if the client can't find any majority + servers but there's partitioned server it could reach, it + connects to one in read-only mode, i.e. read requests are + allowed while write requests are not. It continues seeking for + majority in the background.
    +
    Throws:
    +
    IOException - in cases of network failure
    +
    IllegalArgumentException - if an invalid chroot path is specified
    See Also:
    ZooKeeper.ZooKeeper(String, int, Watcher, boolean)
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    reconfigure
    +
```
public byte[] reconfigure(String joiningServers,
+                 String leavingServers,
+                 String newMembers,
+                 long fromConfig,
+                 Stat stat)
+                   throws KeeperException,
+                          InterruptedException
```
    +
    Reconfigure - add/remove servers. Return the new configuration.
    +
    Parameters:
    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)
    stat - the stat of /zookeeper/config znode will be copied to this + parameter if not null.
    +
    Returns:
    new configuration
    +
    Throws:
    +
    InterruptedException - If the server transaction is interrupted.
    +
    KeeperException - If the server signals an error with a non-zero error code.
    +
  + + + +
  - +
    reconfigure
    +
```
public byte[] reconfigure(List<String> joiningServers,
+                 List<String> leavingServers,
+                 List<String> newMembers,
+                 long fromConfig,
+                 Stat stat)
+                   throws KeeperException,
+                          InterruptedException
```
    +
    Convenience wrapper around reconfig that takes Lists of strings instead of comma-separated servers.
    +
    Throws:
    +
    KeeperException
    +
    InterruptedException
    See Also:
    reconfigure(java.lang.String, java.lang.String, java.lang.String, long, org.apache.zookeeper.data.Stat)
    +
  + + + +
  - +
    reconfigure
    +
```
public void reconfigure(String joiningServers,
+               String leavingServers,
+               String newMembers,
+               long fromConfig,
+               AsyncCallback.DataCallback cb,
+               Object ctx)
```
    +
    The Asynchronous version of reconfig.
    +
    See Also:
    reconfigure(java.lang.String, java.lang.String, java.lang.String, long, org.apache.zookeeper.data.Stat)
    +
  + + + +
  - +
    reconfigure
    +
```
public void reconfigure(List<String> joiningServers,
+               List<String> leavingServers,
+               List<String> newMembers,
+               long fromConfig,
+               AsyncCallback.DataCallback cb,
+               Object ctx)
```
    +
    Convenience wrapper around asynchronous reconfig that takes Lists of strings instead of comma-separated servers.
    +
    See Also:
    reconfigure(java.lang.String, java.lang.String, java.lang.String, long, org.apache.zookeeper.data.Stat)
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    String representation of this ZooKeeperAdmin client. Suitable for things + like logging. + + Do NOT count on the format of this string, it may change without + warning.
    +
    +
    Overrides:
    +
    toString in class ZooKeeper
    +
    Since:
    +
    3.5.3
    +
  +
+

Class ZooKeeperMain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZooKeeperMain

ZooKeeperMain

Method Detail

getPrintWatches

getCommands

printMessage

main

executeLine

delQuota

createQuota

Class ZooKeeperAdmin

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.zookeeper.ZooKeeper

Field Summary

Fields inherited from class org.apache.zookeeper.ZooKeeper

Constructor Summary

Method Summary

Methods inherited from class org.apache.zookeeper.ZooKeeper

Methods inherited from class java.lang.Object

Constructor Detail

ZooKeeperAdmin

ZooKeeperAdmin

ZooKeeperAdmin

Method Detail

reconfigure

reconfigure

reconfigure

reconfigure

toString

Uses of Class
org.apache.zookeeper.admin.ZooKeeperAdmin

org.apache.zookeeper.admin

Classes

Package org.apache.zookeeper.admin

Hierarchy For Package org.apache.zookeeper.admin

Class Hierarchy

Class ZooKeeperMain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZooKeeperMain

ZooKeeperMain

Method Detail

getPrintWatches

getCommands

printMessage

main

executeLine

delQuota

createQuota

Class ZooKeeperAdmin

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.zookeeper.ZooKeeper

Field Summary

Fields inherited from class org.apache.zookeeper.ZooKeeper

Constructor Summary

Method Summary

Methods inherited from class org.apache.zookeeper.ZooKeeper

Methods inherited from class java.lang.Object

Constructor Detail

ZooKeeperAdmin

ZooKeeperAdmin

ZooKeeperAdmin

Method Detail

reconfigure

reconfigure

reconfigure

reconfigure

toString

Uses of Classorg.apache.zookeeper.admin.ZooKeeperAdmin

org.apache.zookeeper.admin

Classes

Package org.apache.zookeeper.admin

Hierarchy For Package org.apache.zookeeper.admin

Class Hierarchy

Uses of Class
org.apache.zookeeper.admin.ZooKeeperAdmin