org.apache.flink.runtime.zookeeper

Class ZooKeeperUtilityFactory

java.lang.Object

org.apache.flink.runtime.zookeeper.ZooKeeperUtilityFactory

public class ZooKeeperUtilityFactory
extends Object

Creates ZooKeeper utility classes without exposing the CuratorFramework dependency. The curator framework is cached in this instance and shared among all created ZooKeeper utility instances. This requires that the utility classes DO NOT close the provided curator framework.

The curator framework is closed by calling the close(boolean) method.

Constructor Summary

Constructors

Constructor and Description
ZooKeeperUtilityFactory(Configuration configuration, String path)

Method Summary

Modifier and Type	Method and Description
void	close(boolean cleanup) Closes the ZooKeeperUtilityFactory.
ZooKeeperSharedCount	createSharedCount(String path, int seedCount) Creates a ZooKeeperSharedCount to store a shared count between multiple instances.
ZooKeeperSharedValue	createSharedValue(String path, byte[] seedValue) Creates a ZooKeeperSharedValue to store a shared value between multiple instances.
<T extends Serializable> ZooKeeperStateHandleStore<T>	createZooKeeperStateHandleStore(String zkStateHandleStorePath, RetrievableStateStorageHelper<T> stateStorageHelper) Creates a ZooKeeperStateHandleStore instance with the provided arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZooKeeperUtilityFactory

public ZooKeeperUtilityFactory(Configuration configuration,
                               String path)
                        throws Exception

Throws:

Exception

Method Detail

close

public void close(boolean cleanup)
           throws Exception

Closes the ZooKeeperUtilityFactory. This entails closing the cached CuratorFramework instance. If cleanup is true, then the initial path and all its children are deleted.

Parameters:

cleanup - deletes the initial path and all of its children to clean up

Throws:

Exception - when deleting the znodes

createZooKeeperStateHandleStore

public <T extends Serializable> ZooKeeperStateHandleStore<T> createZooKeeperStateHandleStore(String zkStateHandleStorePath,
                                                                                             RetrievableStateStorageHelper<T> stateStorageHelper)
                                                                                      throws Exception

Creates a ZooKeeperStateHandleStore instance with the provided arguments.

Type Parameters:

T - Type of the state to be stored

Parameters:

zkStateHandleStorePath - specifying the path in ZooKeeper to store the state handles to

stateStorageHelper - storing the actual state data

Returns:

a ZooKeeperStateHandleStore instance

Throws:

Exception - if ZooKeeper could not create the provided state handle store path in ZooKeeper

createSharedValue

public ZooKeeperSharedValue createSharedValue(String path,
                                              byte[] seedValue)

Creates a ZooKeeperSharedValue to store a shared value between multiple instances.

Parameters:

path - to the shared value in ZooKeeper

seedValue - for the shared value

Returns:

a shared value

createSharedCount

public ZooKeeperSharedCount createSharedCount(String path,
                                              int seedCount)

Creates a ZooKeeperSharedCount to store a shared count between multiple instances.

Parameters:

path - to the shared count in ZooKeeper

seedCount - for the shared count

Returns:

a shared count