All Classes and Interfaces
Class
Description
Set of threads for command ports.
a parser for ACL strings
addAuth command for cli
addWatch command for cli.
Modes available to
ZooKeeper.addWatch(String, Watcher, AddWatchMode)This incremental hash is used to keep track of the hash of
the data tree to that we can quickly validate that things
are in sync.
Interface for an embedded admin server that runs Commands.
Factory class for creating an AdminServer.
Interface definitions of asynchronous callbacks.
This callback is used to retrieve the ACL and stat of the node.
This callback is used to get all children node number of the node.
This callback is used to retrieve the children and stat of the node.
This callback is used to retrieve the children of the node.
This callback is used to retrieve the name and stat of the node.
This callback is used to retrieve the data and stat of the node.
This callback is used to process the getEphemerals results from a single getEphemerals call.
This callback is used to process the multiple results from a single multi call.
This callback is used to retrieve the stat of the node.
This callback is used to retrieve the name of the node.
This callback doesn't retrieve anything from the node.
A FileOutputStream that has the property that it will only show up at its
destination once it has been entirely written and flushed to disk.
Helper class to decouple audit log code.
Contains helper methods to enforce authentication
This interface is implemented by authentication providers to add new kinds of
authentication schemes to ZooKeeper.
Class representing auth data for performing ACL check on admin server commands.
Generic long counter that keep track of min/max/avg.
Generic set of long counters that keep track of min/max/avg
for different keys.
Generic long counter that keep track of min/max/avg/percentiles.
Generic set of long counters that keep track of min/max/avg
for different keys.
Using BitSet to store all the elements, and use HashSet to cache limited
number of elements to find a balance between memory and time complexity.
This is a helper class to maintain the bit to specific value and the
reversed value to bit mapping.
Implements a token-bucket based rate limiting mechanism with optional
probabilistic dropping inspired by the BLUE queue management algorithm [1].
Provides live statistics about Jute buffer usage in term of proposal and client request size.
A bounded blocking queue backed by an array.
Thread safe FIFO CircularBuffer implementation.
base class for all CLI commands
This class manages the socket i/o for the client.
Indicates that the number of client connections has exceeded some limit.
ClientCnxnSocketNetty implements ClientCnxnSocket abstract methods.
X509 utilities specific for client-server communication framework.
close command for cli
Interface implemented by all commands runnable by JettyAdminServer.
A convenient helper to send controller command to ControllerService.
Factory class for creating instances of
CliCommand.All Cli Commands.
An HTTP server listening to incoming controller commands sent from CommandClient (or any of your favorite REST client
) and dispatching the command to the ZooKeeperServerController for execution.
CommandOutputters are used to format the responses from Commands.
A response from running a
Command.Class containing static methods for registering and running Commands, as well
as default Command definitions.
Reset all connection statistics.
Server configuration parameters.
Information on client connections to server.
Digest histories for every specific number of txns.
Information on ZK datadir and snapdir size in bytes
Information on session expirations and ephemerals.
All defined environment variables.
The current trace mask.
Is this server in read-only mode.
Command returns information of the last snapshot that zookeeper server
has finished saving to disk.
Returns the leader status of this instance and the leader host string.
Some useful info for monitoring.
Reset all observer connection statistics.
Restore from snapshot on the current server.
No-op command, check if the server is running
Sets the trace mask.
Take a snapshot of current server and stream out the data.
Server information.
Same as SrvrCommand but has extra "connections" entry.
Resets server statistics.
Information on observer connections to server.
All defined system properties.
Returns the current ensemble configuration information.
Watch information aggregated by session.
Watch information aggregated by path.
Summarized watch information.
Returns the current phase of Zab protocol that peer is running.
This RequestProcessor matches the incoming committed requests with the
locally submitted requests.
Implementation of connection MBean interface.
This MBean represents a client connection.
A parser for ZooKeeper Client connect strings.
Manages cleanup of container ZNodes.
Set of commands that this controller can execute.
Actions available to the controller
Extension of NIOServerCnxn which can inject changes per controller commands.
Extension of NIOServerCnxnFactory which can inject changes per controller commands.
Config for the ControllerService.
Main class which starts a ZooKeeperServer, a ZooKeeperServerController and the ControllerService.
A counter refers to a value which can only increase.
A counter refers to a value which can only increase.
create command for cli
CreateMode value determines how the znode is created on ZooKeeper.
Options for creating znode in ZooKeeper data tree.
Builder for
CreateOptions.This class manages the cleanup of snapshots and corresponding transaction
logs by scheduling the auto purge task with the specified
'autopurge.purgeInterval'.
Status of the dataDir purge task
A class which describes how data should be encrypted and decrypted
This class contains the data for a node in the data tree.
This class maintains the tree data structure.
This class implements the data tree MBean.
Zookeeper data tree MBean.
Default implementation of
It does not implement a real hierarchy of contexts, but metrics are flattened in a single namespace.
It is mostly useful to make the legacy 4 letter words interface work as expected.
MetricsProvider.It does not implement a real hierarchy of contexts, but metrics are flattened in a single namespace.
It is mostly useful to make the legacy 4 letter words interface work as expected.
deleteAll command for cli
delete command for cli
delQuota command for cli
Defines how to calculate the digest for a given node.
Command used to dump the latest digest histories.
This interface is used to notify the digest mismatch event.
A empty watcher implementation used in bench and unit test.
An AdminServer that does nothing.
This is not a true AuthenticationProvider in the strict sense.
Provide insight into the runtime environment.
Abstraction that interprets the
ephemeralOwner field of a ZNode.See https://issues.apache.org/jira/browse/ZOOKEEPER-2901
version 3.5.3 introduced bugs associated with how TTL nodes were implemented.
Exit code used to exit server
Behaviour of the server in case of internal error.
ExpiryQueue tracks elements in time sorted fixed duration buckets.
Implementation of leader election using TCP.
Notifications are messages that let other peers know that
a given peer has changed its vote, either because it has
joined leader election or because it learned of another
peer with higher zxid or same zxid and higher server id
Messages that a peer wants to send to other peers.
Instances of this class can be used to watch a directory for file changes.
This class implements the snapshot interface.
This class implements the TxnLog interface.
this class implements the txnlog iterator interface
which is used for reading the transaction logs
This is a helper class
above the implementations
of txnlog and snapshot
classes
This listener helps
the external apis calling
restore to gather information
while the data is being
restored.
This Request processor actually applies any transaction associated with a
request and services any queries.
This class has the control logic for the Follower.
Follower MBean interface implementation
Follower MBean
This RequestProcessor forwards any requests that modify the state of the
system to the Leader.
Just like the standard ZooKeeperServer.
This class contains constants for all the four letter commands
A Gauge is an application provided object which will be called by the framework in order to sample the value
of an integer value.
A Gauge is an application provided object which will be called by the metrics framework to sample a numeric value.
getAcl command for cli
getAllChildrenNumber command for CLI
get command for cli
Command that represents HTTP GET request
get command for cli
getEphemerals command for CLI
A set of hosts a ZooKeeper client should connect to.
Interface used to process the dead watchers related to closed cnxns.
Interface that acts as an iterator for deserializing maps.
Interface that all the Deserializers have to implement.
This interface is implemented by a class that can be run in an
instance container.
This object is used to report back changes in status.
This class starts up,
This class doles out assignments to InstanceContainers that are registered to
a ZooKeeper znode.
Annotation to inform users of a package, class or method's intended audience.
Intended only for the project(s) specified in the annotation.
Intended for use only within a given project.
Intended for use by any project or application.
Annotation to inform users of how much to rely on a particular package,
class or method not changing over time.
Evolving, but can break compatibility at minor release (i.e.
Can evolve while retaining compatibility for minor release boundaries.;
can break compatibility only at major release (ie.
No guarantee is provided as to reliability or stability across any
level of release granularity.
This class encapsulates a Jetty server for running Commands.
Container for the Hadoop Record DDL.
Abstract Base class for all types supported by Hadoop Record I/O.
This code is originally from hadoop-common, see:
https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/JvmPauseMonitor.java
Class which sets up a simple thread which runs in a loop sleeping
for a short interval of time.
Codes which represent the various KeeperException
types.
Deprecated.
This class implements parsing and handling of Kerberos principal names.
This enum represents the file type of a KeyStore or TrustStore.
This class has the control logic for the Leader.
Leader MBean interface implementation.
Leader election MBean interface implementation
Leader election protocol MBean.
Leader MBean.
Responsible for performing local session upgrade.
The leader session tracker tracks local and global sessions on the leader.
Just like the standard ZooKeeperServer.
This class is the superclass of two of the three main actors in a ZK
ensemble: Followers and Observers.
There will be an instance of this class created by the Leader for each
learner.
This MBean represents a server connection for a learner.
interface for keeping Observers in sync
The learner session tracker is used by learners (followers and observers) to
track zookeeper sessions which may or may not be echoed to the leader.
Utility class to limit the number of concurrent syncs from a leader to
observers and followers or from a follower to observers.
Parent class for all ZooKeeperServers for Learners
listQuota command for cli
Implementation of the local peer MBean interface.
A local zookeeper server MBean interface.
Local session tracker.
this class will chop the log at the specified zxid
Provides a
Logger for use across the entire applicationGeneric skip list for holding a rough index of a log file.
ls command for cli
Shared utilities
This class provides a unified interface for registering/unregistering of
zookeeper MBeans with the platform MBean server.
This class provides a way of buffering sentBuffer and receivedBuffer messages in order.
A MetricsContext is like a namespace for metrics.
A MetricsProvider is a system which collects Metrics and publishes current values to external facilities.
Utility for bootstrap process of MetricsProviders
A generic exception thrown during the licecycle of a MetricsProvider.
Encodes a composite operation.
This class allows to store several quorum and electing addresses.
Handles the response from a multi request.
Helper methods for netty code.
This class contains common utilities for netstuff.
This class handles communication with clients using NIO.
NIOServerCnxnFactory implements a multi-threaded ServerCnxnFactory using
NIO non-blocking socket calls.
The interface defined to manage the hash based on the entries in the
nodes map.
a simple wrapper to ConcurrentHashMap that recalculates a digest after
each mutation.
A Listener for Events on zookeeper nodes
A local cache of ZNodes in front of the Zookeeper server(s) to help cut down on network calls.
An interface to be implented by any component that needs notification when a new element
is selected in the UI JTree representing the set of available ZNodes.
A node viewer for displaying the ACLs currently applied to the selected node
A node viewer for displaying the data for the currently selected node
A node viewer for displaying the meta data for the currently selected node.
A Listener for changes to the configuration of which node viewers are shown
A command that does not do anything except reply to client with predefined message.
This is a dummy MetricsProvider which does nothing.
This class represents no authentication learner, it just return
without performing any authentication.
This class represents no authentication server, it just return
without performing any authentication.
Observers are peers that do not take part in the atomic broadcast protocol.
ObserverBean
Used by Followers to host Observers.
Observer MX Bean interface, implemented by ObserverBean
This RequestProcessor forwards any requests that modify the state of the
system to the Leader.
A ZooKeeperServer for the Observer node type.
Represents a single operation in a multi-operation transaction.
Encodes the result of a single part of a multiple operation commit.
A result from a version check operation.
A result from a create operation.
A result from a delete operation.
An error result from any kind of operation.
A result from a getChildren operation.
A result from a getData operation.
A result from a setData operation.
This class is a wrapper for the implementation of
com.sun.management.UnixOperatingSystemMXBean
It will decide to use the sun api or its own implementation
depending on the runtime (vendor) used.
Interface that all the serializers have to implement.
A utility class for storing a pair of objects
This exception is thrown when parse errors are encountered.
Iterates over a ZooKeeper path.
a class that implements prefix matching for
components of a filesystem path.
Path related utilities
Note: this class is copied from io.airlift.security.pem.PemReader (see
https://github.com/airlift/airlift/blob/master/security/src/main/java/io/airlift/security/pem/PemReader.java) with
permission of the authors, to avoid adding an extra library dependency to Zookeeper.
This request processor is generally at the start of a RequestProcessor
change.
This RequestProcessor simply forwards requests to an AckRequestProcessor and
SyncRequestProcessor.
A manager for switching behaviours between difference wire protocol.
this class is used to clean up the
snapshot and data log dir's.
Interface for quorum learner authentication mechanisms.
Interface for quorum server authentication mechanisms.
This class implements a connection manager for leader election using TCP.
This class implements a validator for hierarchical quorums.
This class implements a validator for majority quorums.
An MBean representing a zookeeper cluster nodes (aka quorum peers)
This class manages the quorum protocol.
(Used for monitoring) When peer is in synchronization phase, this shows
which synchronization mechanism is being used
(Used for monitoring) shows the current phase of
Zab protocol that peer is running.
Configuration file
All quorum validators have to implement a method called
containsQuorum, which verifies if a HashSet of server
identifiers constitutes a quorum.
X509 utilities specific for server-server (quorum) communication framework.
Abstract base class for all ZooKeeperServers that participate in
a quorum.
this class manages quotas
and has many other utils
for quota
A class that provides simple interval-based rate limiting implementation.
This logs the message once in the beginning and once every LOG_INTERVAL.
Token literal values and constants.
Token Manager.
ReadOnly MX Bean interface, implemented by ReadOnlyBean
This processor is at the beginning of the ReadOnlyZooKeeperServer's
processors chain.
A ZooKeeperServer which comes into play when peer is partitioned from the
majority.
reconfig command for cli
Interface that is implemented by generated classes.
Front-end interface to deserializers.
Front-end for serializers.
A remote peer bean only provides limited information about the remote peer,
and the peer cannot be managed remotely.
A proxy for a remote quorum peer.
Remove watches command for cli
This is the structure that represents a request moving through a chain of
RequestProcessors.
This class holds the requests path ( up till a certain depth) stats per request type
RequestProcessors are chained together to process transactions.
When enabled, the RequestThrottler limits the number of outstanding requests
currently submitted to the request processor pipeline.
This is used by the SASL mechanisms to get further information to complete
the authentication.
This is used by the SASL mechanisms to get further information to complete
the authentication.
Computes the Server Principal for a SASL client.
Utility class for handling secret such as key/trust store password
A variation on
AuthenticationProvider that provides additional
parameters for more detailed authenticationAn abstract base class for the leader and follower MBeans.
Interface to a Server connection - represents a connection from a client
to the server.
Server configuration storage.
A quorum server MBean.
Basic Server Statistics
Utilities for service management.
This is the basic interface that ZooKeeperServer uses to track sessions.
This is a full featured SessionTracker.
setAcl command for cli.
set command for cli
setQuota command for cli
A base class for running a Unix command.
This is an IOException with exit code added.
A simple shell command executor.
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (without unicode processing).
The client that gets spawned for the SimpleSysTest
Represent a set of counters identified by different keys.
This does a basic system test.
Slf4j based audit logger
snapshot interface for the persistence layer.
SnapshotComparer is a tool that loads and compares two snapshots with configurable threshold and various filters, and outputs information about the delta.
Dump a snapshot file to stdout.
stores the zxid (as in its file name) and the last modified timestamp
of a snapshot file
Recursively processes a snapshot file collecting child node count and summarizes the data size
below each node.
Represent the Stream used in serialize and deserialize the Snapshot.
Wrapper class for an SSLContext + some config options that can't be set on the context when it is created but
must be set on a secure socket created by the context after the socket creation.
stat command for cli
This class encapsulates the state comparison logic.
Most simple HostProvider, resolves on every next() call.
utility for printing stat values s
a class that represents the stats associated with quotas
A class for streaming data out.
Summaries track the size and number of events.
Summaries track the size and number of events.
sync command for cli
This RequestProcessor logs requests to disk.
Thrown when a
Leader has too many concurrent syncs being sent
to observers.Abstraction that exposes various methods useful for testing ZooKeeper
Class to show tosters in multiplatform
Describes the input token stream.
Token Manager Error.
Provides a builder style interface for doing multiple updates.
Interface for reading transaction logs.
an iterating interface for reading
transaction logs.
A helper class to represent the txn entry.
This class provides an iterator interface to access Proposal deserialized
from on-disk txnlog.
The purpose of this class is to dynamically determine whether to create
a plaintext or SSL connection whenever newConnection() is called.
A ServerSocket that can act either as a regular ServerSocket, as a SSLServerSocket, or as both, depending on
the constructor parameters and on the type of client (TLS or plaintext) that connects to it.
The result of calling accept() on a UnifiedServerSocket.
Manages the unknown requests (i.e.
A session tracker that supports upgradeable local sessions.
A collection of utility methods for dealing with file name parsing,
low level I/O file operations and marshalling/unmarshalling.
Various utility functions for Hadoop record I/O runtime.
version command for cli
Handles the special case of removing watches which has registered for a
client path
A WatchedEvent represents a change on the ZooKeeper that a Watcher
is able to respond to.
This interface specifies the public interface an event handler class must
implement.
This interface defines the possible states an Event may represent
Enumeration of types of events that may occur on the ZooKeeper
Enumeration of states the ZooKeeper may be at the event
Enumeration of types of watchers
Thread used to lazily clean up the closed watcher, it will trigger the
clean up when the dead watchers get certain number or some number of
seconds has elapsed since last clean up.
A watch report, essentially a mapping of path to session IDs of sessions that
have set a watch on that path.
A watch report, essentially a mapping of session ID to paths that the session
has set a watch on.
A summary of watch information.
This class manages watches.
A factory used to produce the actual watch manager based on the
zookeeper.watchManagerName option.
Optimized in memory and time complexity, compared to WatchManager, both the
memory consumption and time complexity improved a lot, but it cannot
efficiently remove the watcher when the session or socket is closed, for
majority use case this is not a problem.
Statistics for multiple different watches on one node.
WhoAmI command for cli
WorkerService is a worker thread pool for running tasks and is implemented
using one or more ExecutorServices.
Callers should implement a class extending WorkRequest in order to
schedule work with the service.
An AuthenticationProvider backed by an X509TrustManager and an X509KeyManager
to perform remote host certificate authentication.
Utility code for X509 handling
Default cipher suites:
Performance testing done by Facebook engineers shows that on Intel x86_64 machines, Java9 performs better with
GCM and Java8 performs better with CBC, so these seem like reasonable defaults.
Enum specifying the client auth requirement of server-side TLS sockets created by this X509Util.
Handles client specific properties
This class is a base class for the configurations of both client and server.
This class maintains the in memory database of zookeeper
server states that includes the sessions, datatree and the
committed logs.
Zookeeper MBean info interface.
A custom TrustManager that supports hostname verification via org.apache.http.conn.ssl.DefaultHostnameVerifier.
The About Dialog for the application
The connection properties dialog.
A Manager for all interactions between the application and the Zookeeper
instance
A default implementation of
ZooInspectorManager for connecting to
zookeeper instancesA Manager for all interactions between the application and the nodes in a
Zookeeper instance
A Manager for all interactions between the application and the node tree in a
Zookeeper instance
A
JPanel for displaying information about the currently selected
node(s)A
JDialog for configuring which ZooInspectorNodeViewers to
show in the applicationThis is the
JPanel which contains the ZooInspectorNodeViewersThe parent
JPanel for the whole applicationA Manager for all read only interactions between the application and a node
in a Zookeeper instance
This is the main class of ZooKeeper client library.
Register a watcher for a particular path.
This is the main class for ZooKeeperAdmin client library.
ZookeeperBanner which writes the 'Zookeeper' banner at the start of zk server.
Represents critical thread.
The command line client to ZooKeeper.
A Class which extends
ZooKeeper and will automatically retry calls to
zookeeper if a KeeperException.ConnectionLossException occurs.This class manages SASL authentication for the client.
This class implements a simple standalone ZooKeeperServer.
This class implements the ZooKeeper server MBean interface.
Configuration data for a
ZooKeeperServer.Class which accepts commands to modify ZooKeeperServer state or Connection state at runtime for the purpose of
single machine integration testing.
This API allows you to start a ZooKeeper server node from Java code
Builder for ZooKeeperServerEmbedded.
Listener for the critical resource events.
This class starts and runs a standalone ZooKeeperServer.
ZooKeeper server MBean.
ZooKeeper server shutdown handler which will be used to handle ERROR or
SHUTDOWN server state transitions, which in turn releases the associated
shutdown latch.
This is the main class for catching all the uncaught exceptions thrown by the
threads.
This class encapsulates and centralizes tracing for the ZooKeeper server.