com.lucidworks.apollo.component

Class ZooKeeperConfigurationComponent

java.lang.Object

com.lucidworks.apollo.component.ZooKeeperConfigurationComponent

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ZooKeeperConfigurationComponent
extends java.lang.Object
implements java.io.Closeable

Creates ZK-backed configuration objects, via Netflix Archaius and Apache Commons Configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ZK_CONFIG_ROOT_PATH
static java.lang.String	ZK_CONFIG_UPDATE_ALLOWED_KEY

Constructor Summary

Constructors

Constructor and Description
ZooKeeperConfigurationComponent(CuratorComponent curatorComponent)

Method Summary

Modifier and Type	Method and Description
ConcurrentCompositeConfiguration	buildCompositeConfiguration(CuratorFramework curatorFramework, ConcurrentCompositeConfiguration defaultConfig, int index) Create one or more Zookeeper-backed ConfigurationSources and insert them into the provided CompositeConfiguration at the given index.
void	close()
void	deleteProperty(java.lang.String key)
void	deleteProperty(java.lang.String zkRoot, java.lang.String key)
java.lang.String	getProperty(java.lang.String key) for testing.
int	getZkConfigurationIndex()
void	init(CuratorComponent curatorComponent) Start up our ZK ConfigurationSources.
void	init(CuratorFramework curator)
void	setProperty(java.lang.String key, java.lang.Object value)
void	setProperty(java.lang.String zkRoot, java.lang.String key, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

ZK_CONFIG_ROOT_PATH

public static final java.lang.String ZK_CONFIG_ROOT_PATH

See Also:

Constant Field Values

ZK_CONFIG_UPDATE_ALLOWED_KEY

public static final java.lang.String ZK_CONFIG_UPDATE_ALLOWED_KEY

See Also:

Constant Field Values

Constructor Detail

ZooKeeperConfigurationComponent

public ZooKeeperConfigurationComponent(CuratorComponent curatorComponent)

Method Detail

init

@WhenReady
public void init(CuratorComponent curatorComponent)
                     throws java.lang.Exception

Start up our ZK ConfigurationSources. We want this to happen just once, at the very beginning.

Throws:

java.lang.Exception

init

public void init(CuratorFramework curator)
          throws java.lang.Exception

Throws:

java.lang.Exception

close

@PreDestroy
public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

buildCompositeConfiguration

public ConcurrentCompositeConfiguration buildCompositeConfiguration(CuratorFramework curatorFramework,
                                                                    ConcurrentCompositeConfiguration defaultConfig,
                                                                    int index)
                                                             throws java.lang.Exception

Create one or more Zookeeper-backed ConfigurationSources and insert them into the provided CompositeConfiguration at the given index. This has side effects, since the ZookeeperConfigurationSource registers watchers w/ Zookeeper to watch for configuration changes. It also modifies the input argument (by inserting ZK configurations into it). Be ye warned.

Parameters:

curatorFramework - should be started

defaultConfig - the config we should insert the new ZK configurations into

index - the index where we should insert the ZK configurations

Returns:

the same ConcurrentCompositeConfiguration that was passed in.

Throws:

java.lang.Exception

deleteProperty

public void deleteProperty(java.lang.String key)

deleteProperty

public void deleteProperty(java.lang.String zkRoot,
                           java.lang.String key)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

setProperty

public void setProperty(java.lang.String zkRoot,
                        java.lang.String key,
                        java.lang.Object value)

getProperty

public java.lang.String getProperty(java.lang.String key)

for testing. Getting things out of ZK should happen using Archaius, via ConfigurationComponent This assumes that the value is a String, since Archaius's ZookeeperConfigurationSource makes the same assumption.

Parameters:

key - the property to look up

Returns:

the value as a String, or null if not found.

Throws:

SerializationException - if the value can't be converted to a String

getZkConfigurationIndex

public int getZkConfigurationIndex()