CuratorFrameworkFactory.Builder (Curator Framework 4.0.1 API)

java.lang.Object
- org.apache.curator.framework.CuratorFrameworkFactory.Builder

Enclosing class:: CuratorFrameworkFactory

public static class CuratorFrameworkFactory.Builder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`CuratorFrameworkFactory.Builder`	`aclProvider(ACLProvider aclProvider)`
`CuratorFrameworkFactory.Builder`	`authorization(java.lang.String scheme, byte[] auth)`	Add connection authorization Subsequent calls to this method overwrite the prior calls.
`CuratorFrameworkFactory.Builder`	`authorization(java.util.List<AuthInfo> authInfos)`	Add connection authorization.
`CuratorFramework`	`build()`	Apply the current values and build a new CuratorFramework
`CuratorTempFramework`	`buildTemp()`	Apply the current values and build a new temporary CuratorFramework.
`CuratorTempFramework`	`buildTemp(long inactiveThreshold, java.util.concurrent.TimeUnit unit)`	Apply the current values and build a new temporary CuratorFramework.
`boolean`	`canBeReadOnly()`
`CuratorFrameworkFactory.Builder`	`canBeReadOnly(boolean canBeReadOnly)`
`CuratorFrameworkFactory.Builder`	`compressionProvider(CompressionProvider compressionProvider)`
`CuratorFrameworkFactory.Builder`	`connectionHandlingPolicy(org.apache.curator.connection.ConnectionHandlingPolicy connectionHandlingPolicy)`	Change the connection handling policy.
`CuratorFrameworkFactory.Builder`	`connectionStateErrorPolicy(ConnectionStateErrorPolicy connectionStateErrorPolicy)`	Set the error policy to use.
`CuratorFrameworkFactory.Builder`	`connectionTimeoutMs(int connectionTimeoutMs)`
`CuratorFrameworkFactory.Builder`	`connectString(java.lang.String connectString)`	Set the list of servers to connect to.
`CuratorFrameworkFactory.Builder`	`defaultData(byte[] defaultData)`	Sets the data to use when `PathAndBytesable.forPath(String)` is used.
`CuratorFrameworkFactory.Builder`	`dontUseContainerParents()`	By default, Curator uses `CreateBuilderMain.creatingParentContainersIfNeeded()` if the ZK JAR supports `CreateMode.CONTAINER`.
`CuratorFrameworkFactory.Builder`	`ensembleProvider(org.apache.curator.ensemble.EnsembleProvider ensembleProvider)`	Set the list ensemble provider.
`ACLProvider`	`getAclProvider()`
`java.util.List<AuthInfo>`	`getAuthInfos()`
`java.lang.String`	`getAuthScheme()`	Deprecated.
`byte[]`	`getAuthValue()`	Deprecated.
`CompressionProvider`	`getCompressionProvider()`
`org.apache.curator.connection.ConnectionHandlingPolicy`	`getConnectionHandlingPolicy()`
`ConnectionStateErrorPolicy`	`getConnectionStateErrorPolicy()`
`int`	`getConnectionTimeoutMs()`
`byte[]`	`getDefaultData()`
`org.apache.curator.ensemble.EnsembleProvider`	`getEnsembleProvider()`
`int`	`getMaxCloseWaitMs()`
`java.lang.String`	`getNamespace()`
`org.apache.curator.RetryPolicy`	`getRetryPolicy()`
`SchemaSet`	`getSchemaSet()`
`int`	`getSessionTimeoutMs()`
`java.util.concurrent.ThreadFactory`	`getThreadFactory()`
`org.apache.curator.utils.ZookeeperFactory`	`getZookeeperFactory()`
`boolean`	`isZk34CompatibilityMode()`
`CuratorFrameworkFactory.Builder`	`maxCloseWaitMs(int maxCloseWaitMs)`
`CuratorFrameworkFactory.Builder`	`namespace(java.lang.String namespace)`	As ZooKeeper is a shared space, users of a given cluster should stay within a pre-defined namespace.
`CuratorFrameworkFactory.Builder`	`retryPolicy(org.apache.curator.RetryPolicy retryPolicy)`
`CuratorFrameworkFactory.Builder`	`schemaSet(SchemaSet schemaSet)`	Add an enforced schema set
`CuratorFrameworkFactory.Builder`	`sessionTimeoutMs(int sessionTimeoutMs)`
`CuratorFrameworkFactory.Builder`	`threadFactory(java.util.concurrent.ThreadFactory threadFactory)`
`boolean`	`useContainerParentsIfAvailable()`
`CuratorFrameworkFactory.Builder`	`zk34CompatibilityMode(boolean mode)`	If mode is true, create a ZooKeeper 3.4.x compatible client.
`CuratorFrameworkFactory.Builder`	`zookeeperFactory(org.apache.curator.utils.ZookeeperFactory zookeeperFactory)`

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

- Method Detail
  - build
```
public CuratorFramework build()
```
    Apply the current values and build a new CuratorFramework
    
    Returns:
    
    new CuratorFramework
  - buildTemp
```
public CuratorTempFramework buildTemp()
```
    Apply the current values and build a new temporary CuratorFramework. Temporary CuratorFramework instances are meant for single requests to ZooKeeper ensembles over a failure prone network such as a WAN. The APIs available from CuratorTempFramework are limited. Further, the connection will be closed after 3 minutes of inactivity.
    
    Returns:
    
    temp instance
  - buildTemp
```
public CuratorTempFramework buildTemp(long inactiveThreshold,
                                      java.util.concurrent.TimeUnit unit)
```
    Apply the current values and build a new temporary CuratorFramework. Temporary CuratorFramework instances are meant for single requests to ZooKeeper ensembles over a failure prone network such as a WAN. The APIs available from CuratorTempFramework are limited. Further, the connection will be closed after inactiveThresholdMs milliseconds of inactivity.
    
    Parameters:
    
    inactiveThreshold - number of milliseconds of inactivity to cause connection close
    
    unit - threshold unit
    
    Returns:
    
    temp instance
  - authorization
```
public CuratorFrameworkFactory.Builder authorization(java.lang.String scheme,
                                                     byte[] auth)
```
    Add connection authorization Subsequent calls to this method overwrite the prior calls.
    
    Parameters:
    
    scheme - the scheme
    
    auth - the auth bytes
    
    Returns:
    
    this
  - authorization
```
public CuratorFrameworkFactory.Builder authorization(java.util.List<AuthInfo> authInfos)
```
    Add connection authorization. The supplied authInfos are appended to those added via call to authorization(java.lang.String, byte[]) for backward compatibility.
    Subsequent calls to this method overwrite the prior calls.
    
    Parameters:
    
    authInfos - list of AuthInfo objects with scheme and auth
    
    Returns:
    
    this
  - connectString
```
public CuratorFrameworkFactory.Builder connectString(java.lang.String connectString)
```
    Set the list of servers to connect to. IMPORTANT: use either this or ensembleProvider(EnsembleProvider) but not both.
    
    Parameters:
    
    connectString - list of servers to connect to
    
    Returns:
    
    this
  - ensembleProvider
```
public CuratorFrameworkFactory.Builder ensembleProvider(org.apache.curator.ensemble.EnsembleProvider ensembleProvider)
```
    Set the list ensemble provider. IMPORTANT: use either this or connectString(String) but not both.
    
    Parameters:
    
    ensembleProvider - the ensemble provider to use
    
    Returns:
    
    this
  - defaultData
```
public CuratorFrameworkFactory.Builder defaultData(byte[] defaultData)
```
    Sets the data to use when PathAndBytesable.forPath(String) is used. This is useful for debugging purposes. For example, you could set this to be the IP of the client.
    
    Parameters:
    
    defaultData - new default data to use
    
    Returns:
    
    this
  - namespace
```
public CuratorFrameworkFactory.Builder namespace(java.lang.String namespace)
```
    As ZooKeeper is a shared space, users of a given cluster should stay within a pre-defined namespace. If a namespace is set here, all paths will get pre-pended with the namespace
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    this
  - sessionTimeoutMs
```
public CuratorFrameworkFactory.Builder sessionTimeoutMs(int sessionTimeoutMs)
```
    Parameters:
    
    sessionTimeoutMs - session timeout
    
    Returns:
    
    this
  - connectionTimeoutMs
```
public CuratorFrameworkFactory.Builder connectionTimeoutMs(int connectionTimeoutMs)
```
    Parameters:
    
    connectionTimeoutMs - connection timeout
    
    Returns:
    
    this
  - maxCloseWaitMs
```
public CuratorFrameworkFactory.Builder maxCloseWaitMs(int maxCloseWaitMs)
```
    Parameters:
    
    maxCloseWaitMs - time to wait during close to join background threads
    
    Returns:
    
    this
  - retryPolicy
```
public CuratorFrameworkFactory.Builder retryPolicy(org.apache.curator.RetryPolicy retryPolicy)
```
    Parameters:
    
    retryPolicy - retry policy to use
    
    Returns:
    
    this
  - threadFactory
```
public CuratorFrameworkFactory.Builder threadFactory(java.util.concurrent.ThreadFactory threadFactory)
```
    Parameters:
    
    threadFactory - thread factory used to create Executor Services
    
    Returns:
    
    this
  - compressionProvider
```
public CuratorFrameworkFactory.Builder compressionProvider(CompressionProvider compressionProvider)
```
    Parameters:
    
    compressionProvider - the compression provider
    
    Returns:
    
    this
  - zookeeperFactory
```
public CuratorFrameworkFactory.Builder zookeeperFactory(org.apache.curator.utils.ZookeeperFactory zookeeperFactory)
```
    Parameters:
    
    zookeeperFactory - the zookeeper factory to use
    
    Returns:
    
    this
  - aclProvider
```
public CuratorFrameworkFactory.Builder aclProvider(ACLProvider aclProvider)
```
    Parameters:
    
    aclProvider - a provider for ACLs
    
    Returns:
    
    this
  - canBeReadOnly
```
public CuratorFrameworkFactory.Builder canBeReadOnly(boolean canBeReadOnly)
```
    Parameters:
    
    canBeReadOnly - if true, allow ZooKeeper client to enter read only mode in case of a network partition. See ZooKeeper(String, int, Watcher, long, byte[], boolean) for details
    
    Returns:
    
    this
  - dontUseContainerParents
```
public CuratorFrameworkFactory.Builder dontUseContainerParents()
```
    By default, Curator uses CreateBuilderMain.creatingParentContainersIfNeeded() if the ZK JAR supports CreateMode.CONTAINER. Call this method to turn off this behavior.
    
    Returns:
    
    this
  - connectionStateErrorPolicy
```
public CuratorFrameworkFactory.Builder connectionStateErrorPolicy(ConnectionStateErrorPolicy connectionStateErrorPolicy)
```
    Set the error policy to use. The default is StandardConnectionStateErrorPolicy
    
    Parameters:
    
    connectionStateErrorPolicy - new error policy
    
    Returns:
    
    this
    
    Since:
    
    3.0.0
  - zk34CompatibilityMode
```
public CuratorFrameworkFactory.Builder zk34CompatibilityMode(boolean mode)
```
    If mode is true, create a ZooKeeper 3.4.x compatible client. IMPORTANT: If the client library used is ZooKeeper 3.4.x zk34CompatibilityMode is enabled by default.
    
    Parameters:
    
    mode - true/false
    
    Returns:
    
    this
    
    Since:
    
    3.5.0
  - connectionHandlingPolicy
```
public CuratorFrameworkFactory.Builder connectionHandlingPolicy(org.apache.curator.connection.ConnectionHandlingPolicy connectionHandlingPolicy)
```
    Change the connection handling policy. The default policy is StandardConnectionHandlingPolicy.
    
    IMPORTANT: StandardConnectionHandlingPolicy has different behavior than the connection policy handling prior to version 3.0.0.
    
    Major differences from the older behavior are:
    - Session/connection timeouts are no longer managed by the low-level client. They are managed by the CuratorFramework instance. There should be no noticeable differences.
    - Prior to 3.0.0, each iteration of the retry policy would allow the connection timeout to elapse if the connection hadn't yet succeeded. This meant that the true connection timeout was the configured value times the maximum retries in the retry policy. This longstanding issue has been address. Now, the connection timeout can elapse only once for a single API call.
    - MOST IMPORTANTLY! Prior to 3.0.0, ConnectionState.LOST did not imply a lost session (much to the confusion of users). Now, Curator will set the LOST state only when it believes that the ZooKeeper session has expired. ZooKeeper connections have a session. When the session expires, clients must take appropriate action. In Curator, this is complicated by the fact that Curator internally manages the ZooKeeper connection. Now, Curator will set the LOST state when any of the following occurs: a) ZooKeeper returns a Watcher.Event.KeeperState.Expired or KeeperException.Code.SESSIONEXPIRED; b) Curator closes the internally managed ZooKeeper instance; c) The session timeout elapses during a network partition.
    Parameters:
    
    connectionHandlingPolicy - the policy
    
    Returns:
    
    this
    
    Since:
    
    3.0.0
  - schemaSet
```
public CuratorFrameworkFactory.Builder schemaSet(SchemaSet schemaSet)
```
    Add an enforced schema set
    
    Parameters:
    
    schemaSet - the schema set
    
    Returns:
    
    this
    
    Since:
    
    3.2.0
  - getAclProvider
```
public ACLProvider getAclProvider()
```
  - getZookeeperFactory
```
public org.apache.curator.utils.ZookeeperFactory getZookeeperFactory()
```
  - getCompressionProvider
```
public CompressionProvider getCompressionProvider()
```
  - getThreadFactory
```
public java.util.concurrent.ThreadFactory getThreadFactory()
```
  - getEnsembleProvider
```
public org.apache.curator.ensemble.EnsembleProvider getEnsembleProvider()
```
  - getSessionTimeoutMs
```
public int getSessionTimeoutMs()
```
  - getConnectionTimeoutMs
```
public int getConnectionTimeoutMs()
```
  - getMaxCloseWaitMs
```
public int getMaxCloseWaitMs()
```
  - getRetryPolicy
```
public org.apache.curator.RetryPolicy getRetryPolicy()
```
  - getNamespace
```
public java.lang.String getNamespace()
```
  - useContainerParentsIfAvailable
```
public boolean useContainerParentsIfAvailable()
```
  - getConnectionStateErrorPolicy
```
public ConnectionStateErrorPolicy getConnectionStateErrorPolicy()
```
  - getConnectionHandlingPolicy
```
public org.apache.curator.connection.ConnectionHandlingPolicy getConnectionHandlingPolicy()
```
  - getSchemaSet
```
public SchemaSet getSchemaSet()
```
  - isZk34CompatibilityMode
```
public boolean isZk34CompatibilityMode()
```
  - getAuthScheme
```
@Deprecated
public java.lang.String getAuthScheme()
```
    Deprecated.
  - getAuthValue
```
@Deprecated
public byte[] getAuthValue()
```
    Deprecated.
  - getAuthInfos
```
public java.util.List<AuthInfo> getAuthInfos()
```
  - getDefaultData
```
public byte[] getDefaultData()
```
  - canBeReadOnly
```
public boolean canBeReadOnly()
```

Class CuratorFrameworkFactory.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

buildTemp

buildTemp

authorization

authorization

connectString

ensembleProvider

defaultData

namespace

sessionTimeoutMs

connectionTimeoutMs

maxCloseWaitMs

retryPolicy

threadFactory

compressionProvider

zookeeperFactory

aclProvider

canBeReadOnly

dontUseContainerParents

connectionStateErrorPolicy

zk34CompatibilityMode

connectionHandlingPolicy

schemaSet

getAclProvider

getZookeeperFactory

getCompressionProvider

getThreadFactory

getEnsembleProvider

getSessionTimeoutMs

getConnectionTimeoutMs

getMaxCloseWaitMs

getRetryPolicy

getNamespace

useContainerParentsIfAvailable

getConnectionStateErrorPolicy

getConnectionHandlingPolicy

getSchemaSet

isZk34CompatibilityMode

getAuthScheme

getAuthValue

getAuthInfos

getDefaultData

canBeReadOnly