org.apache.curator.framework.imps

Class CuratorFrameworkBase

java.lang.Object

org.apache.curator.framework.imps.CuratorFrameworkBase

All Implemented Interfaces:

Closeable, AutoCloseable, CuratorFramework

Direct Known Subclasses:

CuratorFrameworkImpl

public abstract class CuratorFrameworkBase
extends Object
implements CuratorFramework

This is the base class of all CuratorFrameworks, it is public for private usages (a.k.a. impls/details package).

Most internal codes should use CuratorFrameworkBase instead of CuratorFrameworkImpl, so functionalities could be added additively by overriding methods in DelegatingCuratorFramework.

An instance of CuratorFramework MUST BE an instance of CuratorFrameworkBase.

Constructor Summary

Constructors

Constructor and Description
CuratorFrameworkBase()

Method Summary

Modifier and Type	Method and Description
ExistsBuilder	checkExists() Start an exists builder
protected void	checkState()
abstract CuratorFramework	client() Return the underlying client which is the one constructed from CuratorFrameworkFactory.
CreateBuilder	create() Start a create builder
void	createContainers(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
GetDataBuilder	getData() Start a get data builder
String	getNamespace() Return the current namespace or "" if none
protected void	internalSync(CuratorFrameworkBase impl, String path, Object context)
CuratorTransaction	inTransaction() Start a transaction builder
org.apache.curator.utils.EnsurePath	newNamespaceAwareEnsurePath(String path) Deprecated.
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() Returns a facade of the current instance that does _not_ automatically pre-pend the namespace to all paths
ReconfigBuilder	reconfig() Start a reconfig builder
SetACLBuilder	setACL() Start a set ACL builder
SetDataBuilder	setData() Start a set data builder
SyncBuilder	sync() Start a sync builder.
void	sync(String path, 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().
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

blockUntilConnected, blockUntilConnected, clearWatcherReferences, close, compressionEnabled, getConnectionStateErrorPolicy, getConnectionStateListenable, getCuratorListenable, getCurrentConfig, getSchemaSet, getState, getUnhandledErrorListenable, getZookeeperClient, getZookeeperCompatibility, isStarted, postSafeNotify, runSafe, start, usingNamespace

Constructor Detail

CuratorFrameworkBase

public CuratorFrameworkBase()

Method Detail

client

public abstract CuratorFramework client()

Return the underlying client which is the one constructed from CuratorFrameworkFactory.

nonNamespaceView

public final CuratorFramework nonNamespaceView()

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 final String getNamespace()

Description copied from interface: CuratorFramework

Return the current namespace or "" if none

Specified by:

getNamespace in interface CuratorFramework

Returns:

namespace

newNamespaceAwareEnsurePath

@Deprecated
public org.apache.curator.utils.EnsurePath newNamespaceAwareEnsurePath(String path)

Deprecated.

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

checkState

protected final void checkState()

internalSync

protected final void internalSync(CuratorFrameworkBase impl,
                                  String path,
                                  Object context)

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

sync

public void sync(String path,
                 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 final RemoveWatchesBuilder watches()

Description copied from interface: CuratorFramework

Start a remove watches builder.

Specified by:

watches in interface CuratorFramework

Returns:

builder object

watchers

public final 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

createContainers

public final void createContainers(String path)
                            throws 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:

Exception - errors

newWatcherRemoveCuratorFramework

public final 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