net.dempsy.distconfig

Class PropertiesStore

java.lang.Object

net.dempsy.distconfig.PropertiesStore

Direct Known Subclasses:

ApacheVfsPropertiesStore, ClusterInfoPropertiesStore

public abstract class PropertiesStore
extends Object

This is a abstraction for storing/sharing distributed properties. Properties used through this system are versioned. Some implementations may allow retrieval of the Properties history.

Constructor Summary

Constructors

Constructor and Description
PropertiesStore()

Method Summary

Modifier and Type	Method and Description
abstract int	clear(String... propNames) This will clear the given properties by name.
abstract int	merge(Properties props) This will merge the new properties with the old properties overwriting where there are clashes.
abstract int	push(Properties props) This will basically clear the existing properties and replace them with the new set.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesStore

public PropertiesStore()

Method Detail

push

public abstract int push(Properties props)
                  throws IOException

This will basically clear the existing properties and replace them with the new set. The return value is a version identifier for the new version. The format is specific to the underlying implementation. Version numbers will be increasing but they don't need to be sequential.

Parameters:

props - is the Properties to store.

Returns:

the new version of the properties.

Throws:

IOException - if the underlying transport or storage mechanism throws an IOException

merge

public abstract int merge(Properties props)
                   throws IOException

This will merge the new properties with the old properties overwriting where there are clashes.

Parameters:

props - is the Properties to store.

Returns:

the new version of the properties.

Throws:

IOException - if the underlying transport or storage mechanism throws an IOException

clear

public abstract int clear(String... propNames)
                   throws IOException

This will clear the given properties by name.

Parameters:

propNames - is the set of keys to clear from the distributed properties.

Returns:

the new version of the properties.

Throws:

IOException - if the underlying transport or storage mechanism throws an IOException