Package org.apache.zookeeper.admin

Class ZooKeeperAdmin

  • All Implemented Interfaces:
    AutoCloseable
    @Public
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

    • 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(String, int, Watcher)

      • ZooKeeperAdmin

        public ZooKeeperAdmin​(String connectString,
                      int sessionTimeout,
                      Watcher watcher,
                      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(String, int, Watcher, ZKClientConfig)

      • ZooKeeperAdmin

        public ZooKeeperAdmin​(String connectString,
                      int sessionTimeout,
                      Watcher watcher,
                      boolean canBeReadOnly,
                      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
        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.
        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
        Since:
        3.6.1
        See Also:
        ZooKeeper(String, int, Watcher, boolean, 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(String, int, Watcher, boolean)