org.kuali.rice.core.config
Class SimpleNodeSettingsStore

java.lang.Object
  org.kuali.rice.core.config.SimpleNodeSettingsStore

All Implemented Interfaces:

NodeSettings, org.springframework.beans.factory.InitializingBean

public class SimpleNodeSettingsStore
extends Object
implements NodeSettings, org.springframework.beans.factory.InitializingBean

A simple node settings store that backs the settings with a properties file

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

private boolean	enabled
private static org.apache.log4j.Logger	LOG
private Properties	properties
private String	propertiesPath

Constructor Summary

SimpleNodeSettingsStore()

Method Summary

void	afterPropertiesSet()
String	getSetting(String key) Retrieve the value of the setting with the given name.
Map<String,String>	getSettings() Returns the settings of this node as an immutable Map.
boolean	isEnabled() Returns true if node-specific settings are enabled, false otherwise.
protected Properties	load()
String	removeSetting(String key) Remove the given setting from the node settings.
void	setPropertiesPath(String path)
void	setSetting(String key, String value) Set the value of the setting with the given name.
protected void	store(Properties p)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

enabled

private boolean enabled

propertiesPath

private String propertiesPath

properties

private Properties properties

Constructor Detail

SimpleNodeSettingsStore

public SimpleNodeSettingsStore()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

load

protected Properties load()
                   throws IOException

Throws:

IOException

setPropertiesPath

public void setPropertiesPath(String path)

store

protected void store(Properties p)

getSetting

public String getSetting(String key)

Description copied from interface: NodeSettings

Retrieve the value of the setting with the given name. Will return null if the setting with the given name does not exist or node settings are not enabled.

Specified by:

getSetting in interface NodeSettings

Returns:

the value of the setting, null if the setting does not exis or node settings are not enabled

setSetting

public void setSetting(String key,
                       String value)

Description copied from interface: NodeSettings

Set the value of the setting with the given name. Has no effect if node settings are not enabled.

Specified by:

setSetting in interface NodeSettings

removeSetting

public String removeSetting(String key)

Description copied from interface: NodeSettings

Remove the given setting from the node settings. If the setting with the given name does not exist or node settings are not enabled, then null will be returned.

Specified by:

removeSetting in interface NodeSettings

Returns:

return the value of the removed setting, null if the setting does not exist or node settings are not enabled

getSettings

public Map<String,String> getSettings()

Description copied from interface: NodeSettings

Returns the settings of this node as an immutable Map. If the node settings store is not enabled, then an empty Map will be returned. The Map returned by the getSettings method is thread-safe.

Specified by:

getSettings in interface NodeSettings

Returns:

isEnabled

public boolean isEnabled()

Description copied from interface: NodeSettings

Returns true if node-specific settings are enabled, false otherwise. In the case that node settings are not enabled, the various accessor methods will effectively behave as no-ops.

Specified by:

isEnabled in interface NodeSettings

Returns:

true if node settings are enabled, false otherwise