Package org.apache.curator.framework.imps

Class CuratorFrameworkImpl

java.lang.Object

org.apache.curator.framework.imps.CuratorFrameworkImpl

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, CuratorFramework

public class CuratorFrameworkImpl
extends java.lang.Object
implements CuratorFramework

Field Summary

Fields

Modifier and Type	Field	Description
UnhandledErrorListener	debugUnhandledErrorListener

Constructor Summary

Constructors

Modifier	Constructor	Description
	CuratorFrameworkImpl(CuratorFrameworkFactory.Builder builder)
protected	CuratorFrameworkImpl(CuratorFrameworkImpl parent)

Method Summary

Modifier and Type	Method	Description
void	blockUntilConnected()	Block until a connection to ZooKeeper is available.
boolean	blockUntilConnected(int maxWaitTime, java.util.concurrent.TimeUnit units)	Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded
ExistsBuilder	checkExists()	Start an exists builder
void	clearWatcherReferences(org.apache.zookeeper.Watcher watcher)	Curator can hold internal references to watchers that may inhibit garbage collection.
void	close()	Stop the client
CreateBuilder	create()	Start a create builder
void	createContainers(java.lang.String path)	Create all nodes in the specified path as containers if they don't already exist
DeleteBuilder	delete()	Start a delete builder
GetACLBuilder	getACL()	Start a get ACL builder
GetChildrenBuilder	getChildren()	Start a get children builder
GetConfigBuilder	getConfig()	Start a getConfig builder
ConnectionStateErrorPolicy	getConnectionStateErrorPolicy()	Return the configured error policy
Listenable<ConnectionStateListener>	getConnectionStateListenable()	Returns the listenable interface for the Connect State
Listenable<CuratorListener>	getCuratorListenable()	Returns the listenable interface for events
org.apache.zookeeper.server.quorum.flexible.QuorumVerifier	getCurrentConfig()	Current maintains a cached view of the Zookeeper quorum config.
GetDataBuilder	getData()	Start a get data builder
java.lang.String	getNamespace()	Return the current namespace or "" if none
SchemaSet	getSchemaSet()	Return this instance's schema set
CuratorFrameworkState	getState()	Returns the state of this instance
Listenable<UnhandledErrorListener>	getUnhandledErrorListenable()	Returns the listenable interface for unhandled errors
org.apache.curator.CuratorZookeeperClient	getZookeeperClient()	Return the managed zookeeper client
protected void	internalSync(CuratorFrameworkImpl impl, java.lang.String path, java.lang.Object context)
CuratorTransaction	inTransaction()	Start a transaction builder
boolean	isStarted()	Deprecated.
org.apache.curator.utils.EnsurePath	newNamespaceAwareEnsurePath(java.lang.String path)	Allocates an ensure path instance that is namespace aware
WatcherRemoveCuratorFramework	newWatcherRemoveCuratorFramework()	Returns a facade of the current instance that tracks watchers created and allows a one-shot removal of all watchers via WatcherRemoveCuratorFramework.removeWatchers()
CuratorFramework	nonNamespaceView()	Deprecated.
ReconfigBuilder	reconfig()	Start a reconfig builder
java.util.concurrent.CompletableFuture<java.lang.Void>	runSafe(java.lang.Runnable runnable)	Curator (and user) recipes can use this to run notifyAll and other blocking calls that might normally block ZooKeeper's event thread.
SetACLBuilder	setACL()	Start a set ACL builder
SetDataBuilder	setData()	Start a set data builder
void	start()	Start the client.
SyncBuilder	sync()	Start a sync builder.
void	sync(java.lang.String path, java.lang.Object context)	Perform a sync on the given path - syncs are always in the background
CuratorMultiTransaction	transaction()	Start a transaction builder
TransactionOp	transactionOp()	Allocate an operation that can be used with CuratorFramework.transaction().
CuratorFramework	usingNamespace(java.lang.String newNamespace)	Returns a facade of the current instance that uses the specified namespace or no namespace if newNamespace is null.
WatchesBuilder	watchers()	Start a watch builder.
RemoveWatchesBuilder	watches()	Start a remove watches builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.curator.framework.CuratorFramework

postSafeNotify

Field Detail

debugUnhandledErrorListener

public volatile UnhandledErrorListener debugUnhandledErrorListener

Constructor Detail

CuratorFrameworkImpl

public CuratorFrameworkImpl(CuratorFrameworkFactory.Builder builder)

CuratorFrameworkImpl

protected CuratorFrameworkImpl(CuratorFrameworkImpl parent)

Method Detail

runSafe

public java.util.concurrent.CompletableFuture<java.lang.Void> runSafe(java.lang.Runnable runnable)

Description copied from interface: CuratorFramework

Curator (and user) recipes can use this to run notifyAll and other blocking calls that might normally block ZooKeeper's event thread.

Specified by:

runSafe in interface CuratorFramework

Parameters:

runnable - proc to call from a safe internal thread

Returns:

a CompletableFuture that can be used to monitor when the call is complete

newWatcherRemoveCuratorFramework

public WatcherRemoveCuratorFramework newWatcherRemoveCuratorFramework()

Description copied from interface: CuratorFramework

Returns a facade of the current instance that tracks watchers created and allows a one-shot removal of all watchers via WatcherRemoveCuratorFramework.removeWatchers()

Specified by:

newWatcherRemoveCuratorFramework in interface CuratorFramework

Returns:

facade

getCurrentConfig

public org.apache.zookeeper.server.quorum.flexible.QuorumVerifier getCurrentConfig()

Description copied from interface: CuratorFramework

Current maintains a cached view of the Zookeeper quorum config.

Specified by:

getCurrentConfig in interface CuratorFramework

Returns:

the current config

createContainers

public void createContainers(java.lang.String path)
                      throws java.lang.Exception

Description copied from interface: CuratorFramework

Create all nodes in the specified path as containers if they don't already exist

Specified by:

createContainers in interface CuratorFramework

Parameters:

path - path to create

Throws:

java.lang.Exception - errors

clearWatcherReferences

public void clearWatcherReferences(org.apache.zookeeper.Watcher watcher)

Description copied from interface: CuratorFramework

Curator can hold internal references to watchers that may inhibit garbage collection. Call this method on watchers you are no longer interested in.

Specified by:

clearWatcherReferences in interface CuratorFramework

Parameters:

watcher - the watcher

getState

public CuratorFrameworkState getState()

Description copied from interface: CuratorFramework

Returns the state of this instance

Specified by:

getState in interface CuratorFramework

Returns:

state

isStarted

@Deprecated
public boolean isStarted()

Deprecated.

Description copied from interface: CuratorFramework

Return true if the client is started, not closed, etc.

Specified by:

isStarted in interface CuratorFramework

Returns:

true/false

blockUntilConnected

public boolean blockUntilConnected(int maxWaitTime,
                                   java.util.concurrent.TimeUnit units)
                            throws java.lang.InterruptedException

Description copied from interface: CuratorFramework

Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded

Specified by:

blockUntilConnected in interface CuratorFramework

Parameters:

maxWaitTime - The maximum wait time. Specify a value <= 0 to wait indefinitely

units - The time units for the maximum wait time.

Returns:

True if connection has been established, false otherwise.

Throws:

java.lang.InterruptedException - If interrupted while waiting

blockUntilConnected

public void blockUntilConnected()
                         throws java.lang.InterruptedException

Description copied from interface: CuratorFramework

Block until a connection to ZooKeeper is available. This method will not return until a connection is available or it is interrupted, in which case an InterruptedException will be thrown

Specified by:

blockUntilConnected in interface CuratorFramework

Throws:

java.lang.InterruptedException - If interrupted while waiting

getConnectionStateErrorPolicy

public ConnectionStateErrorPolicy getConnectionStateErrorPolicy()

Description copied from interface: CuratorFramework

Return the configured error policy

Specified by:

getConnectionStateErrorPolicy in interface CuratorFramework

Returns:

error policy

start

public void start()

Description copied from interface: CuratorFramework

Start the client. Most mutator methods will not work until the client is started

Specified by:

start in interface CuratorFramework

close

public void close()

Description copied from interface: CuratorFramework

Stop the client

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface CuratorFramework

nonNamespaceView

@Deprecated
public CuratorFramework nonNamespaceView()

Deprecated.

Description copied from interface: CuratorFramework

Returns a facade of the current instance that does _not_ automatically pre-pend the namespace to all paths

Specified by:

nonNamespaceView in interface CuratorFramework

Returns:

facade

getNamespace

public java.lang.String getNamespace()

Description copied from interface: CuratorFramework

Return the current namespace or "" if none

Specified by:

getNamespace in interface CuratorFramework

Returns:

namespace

usingNamespace

public CuratorFramework usingNamespace(java.lang.String newNamespace)

Description copied from interface: CuratorFramework

Returns a facade of the current instance that uses the specified namespace or no namespace if newNamespace is null.

Specified by:

usingNamespace in interface CuratorFramework

Parameters:

newNamespace - the new namespace or null for none

Returns:

facade

create

public CreateBuilder create()

Description copied from interface: CuratorFramework

Start a create builder

Specified by:

create in interface CuratorFramework

Returns:

builder object

delete

public DeleteBuilder delete()

Description copied from interface: CuratorFramework

Start a delete builder

Specified by:

delete in interface CuratorFramework

Returns:

builder object

checkExists

public ExistsBuilder checkExists()

Description copied from interface: CuratorFramework

Start an exists builder

The builder will return a Stat object as if org.apache.zookeeper.ZooKeeper.exists() were called. Thus, a null means that it does not exist and an actual Stat object means it does exist.

Specified by:

checkExists in interface CuratorFramework

Returns:

builder object

getData

public GetDataBuilder getData()

Description copied from interface: CuratorFramework

Start a get data builder

Specified by:

getData in interface CuratorFramework

Returns:

builder object

setData

public SetDataBuilder setData()

Description copied from interface: CuratorFramework

Start a set data builder

Specified by:

setData in interface CuratorFramework

Returns:

builder object

getChildren

public GetChildrenBuilder getChildren()

Description copied from interface: CuratorFramework

Start a get children builder

Specified by:

getChildren in interface CuratorFramework

Returns:

builder object

getACL

public GetACLBuilder getACL()

Description copied from interface: CuratorFramework

Start a get ACL builder

Specified by:

getACL in interface CuratorFramework

Returns:

builder object

setACL

public SetACLBuilder setACL()

Description copied from interface: CuratorFramework

Start a set ACL builder

Specified by:

setACL in interface CuratorFramework

Returns:

builder object

reconfig

public ReconfigBuilder reconfig()

Description copied from interface: CuratorFramework

Start a reconfig builder

Specified by:

reconfig in interface CuratorFramework

Returns:

builder object

getConfig

public GetConfigBuilder getConfig()

Description copied from interface: CuratorFramework

Start a getConfig builder

Specified by:

getConfig in interface CuratorFramework

Returns:

builder object

inTransaction

public CuratorTransaction inTransaction()

Description copied from interface: CuratorFramework

Start a transaction builder

Specified by:

inTransaction in interface CuratorFramework

Returns:

builder object

transaction

public CuratorMultiTransaction transaction()

Description copied from interface: CuratorFramework

Start a transaction builder

Specified by:

transaction in interface CuratorFramework

Returns:

builder object

transactionOp

public TransactionOp transactionOp()

Description copied from interface: CuratorFramework

Allocate an operation that can be used with CuratorFramework.transaction(). NOTE: CuratorOp instances created by this builder are reusable.

Specified by:

transactionOp in interface CuratorFramework

Returns:

operation builder

getConnectionStateListenable

public Listenable<ConnectionStateListener> getConnectionStateListenable()

Description copied from interface: CuratorFramework

Returns the listenable interface for the Connect State

Specified by:

getConnectionStateListenable in interface CuratorFramework

Returns:

listenable

getCuratorListenable

public Listenable<CuratorListener> getCuratorListenable()

Description copied from interface: CuratorFramework

Returns the listenable interface for events

Specified by:

getCuratorListenable in interface CuratorFramework

Returns:

listenable

getUnhandledErrorListenable

public Listenable<UnhandledErrorListener> getUnhandledErrorListenable()

Description copied from interface: CuratorFramework

Returns the listenable interface for unhandled errors

Specified by:

getUnhandledErrorListenable in interface CuratorFramework

Returns:

listenable

sync

public void sync(java.lang.String path,
                 java.lang.Object context)

Description copied from interface: CuratorFramework

Perform a sync on the given path - syncs are always in the background

Specified by:

sync in interface CuratorFramework

Parameters:

path - the path

context - optional context

sync

public SyncBuilder sync()

Description copied from interface: CuratorFramework

Start a sync builder. Note: sync is ALWAYS in the background even if you don't use one of the background() methods

Specified by:

sync in interface CuratorFramework

Returns:

builder object

watches

public RemoveWatchesBuilder watches()

Description copied from interface: CuratorFramework

Start a remove watches builder.

Specified by:

watches in interface CuratorFramework

Returns:

builder object

watchers

public WatchesBuilder watchers()

Description copied from interface: CuratorFramework

Start a watch builder. Supported only when ZooKeeper JAR of version 3.6 or above is used, throws IllegalStateException for ZooKeeper JAR 3.5 or below

Specified by:

watchers in interface CuratorFramework

Returns:

builder object

internalSync

protected void internalSync(CuratorFrameworkImpl impl,
                            java.lang.String path,
                            java.lang.Object context)

getZookeeperClient

public org.apache.curator.CuratorZookeeperClient getZookeeperClient()

Description copied from interface: CuratorFramework

Return the managed zookeeper client

Specified by:

getZookeeperClient in interface CuratorFramework

Returns:

client

newNamespaceAwareEnsurePath

public org.apache.curator.utils.EnsurePath newNamespaceAwareEnsurePath(java.lang.String path)

Description copied from interface: CuratorFramework

Allocates an ensure path instance that is namespace aware

Specified by:

newNamespaceAwareEnsurePath in interface CuratorFramework

Parameters:

path - path to ensure

Returns:

new EnsurePath instance

getSchemaSet

public SchemaSet getSchemaSet()

Description copied from interface: CuratorFramework

Return this instance's schema set

Specified by:

getSchemaSet in interface CuratorFramework

Returns:

schema set