Module com.aoapps.appcluster.core

Package com.aoapps.appcluster

Class AppClusterPropertiesConfiguration

java.lang.Object

com.aoapps.appcluster.AppClusterPropertiesConfiguration

All Implemented Interfaces:

AppClusterConfiguration

public class AppClusterPropertiesConfiguration
extends Object
implements AppClusterConfiguration

The configuration is provided in a properties file.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
AppClusterPropertiesConfiguration(File file)	Loads the properties from the provided file.
AppClusterPropertiesConfiguration(Properties properties)	Uses the provided configuration.

Method Summary

Modifier and Type	Method	Description
void	addConfigurationListener(AppClusterConfigurationListener listener)	Will be called when the configuration has changed in any way.
boolean	getBoolean(String propertyName)
String	getDisplay()
int	getInt(String propertyName)
Name	getName(String propertyName)
Set<? extends NodePropertiesConfiguration>	getNodeConfigurations()	Gets the set of nodes for the cluster.
Set<? extends ResourceConfiguration<?,?>>	getResourceConfigurations()	Gets the set of resources for the cluster.
Schedule	getSchedule(String propertyName)
String	getString(String propertyName, boolean required)	Gets a trimmed property value, if required, not allowing null or empty string.
Set<? extends Name>	getUniqueNames(String propertyName)	Gets a unique set of trimmed names.
Set<String>	getUniqueStrings(String propertyName, boolean required)	Gets a unique set of trimmed strings.
boolean	isEnabled()
void	removeConfigurationListener(AppClusterConfigurationListener listener)	Removes listener of configuration changes.
void	start()	Called as the AppCluster starts, before any configuration values are accessed or listeners are added.
void	stop()	Called as the AppCluster stops, after all configuration values have been accessed and all listeners have been removed.

Methods inherited from class java.lang.Object

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

Constructor Details

AppClusterPropertiesConfiguration

public AppClusterPropertiesConfiguration(File file)

Loads the properties from the provided file. Will detect changes in the file based on modified time, checking once every FILE_CHECK_INTERVAL milliseconds.

AppClusterPropertiesConfiguration

public AppClusterPropertiesConfiguration(Properties properties)

Uses the provided configuration. No changes to the properties will be detected.

Method Details

start

public void start()
           throws AppClusterConfigurationException

Description copied from interface: AppClusterConfiguration

Called as the AppCluster starts, before any configuration values are accessed or listeners are added.

Specified by:

start in interface AppClusterConfiguration

Throws:

AppClusterConfigurationException

stop

public void stop()

Description copied from interface: AppClusterConfiguration

Called as the AppCluster stops, after all configuration values have been accessed and all listeners have been removed.

Specified by:

stop in interface AppClusterConfiguration

addConfigurationListener

public void addConfigurationListener(AppClusterConfigurationListener listener)

Description copied from interface: AppClusterConfiguration

Will be called when the configuration has changed in any way.

Specified by:

addConfigurationListener in interface AppClusterConfiguration

removeConfigurationListener

public void removeConfigurationListener(AppClusterConfigurationListener listener)

Description copied from interface: AppClusterConfiguration

Removes listener of configuration changes.

Specified by:

removeConfigurationListener in interface AppClusterConfiguration

getString

public String getString(String propertyName,
 boolean required)
                 throws AppClusterConfigurationException

Gets a trimmed property value, if required, not allowing null or empty string. If not required, will convert empty string to null.

Throws:

AppClusterConfigurationException

getBoolean

public boolean getBoolean(String propertyName)
                   throws AppClusterConfigurationException

Throws:

AppClusterConfigurationException

getInt

public int getInt(String propertyName)
           throws AppClusterConfigurationException

Throws:

AppClusterConfigurationException

getName

public Name getName(String propertyName)
             throws AppClusterConfigurationException

Throws:

AppClusterConfigurationException

getSchedule

public Schedule getSchedule(String propertyName)
                     throws AppClusterConfigurationException

Throws:

AppClusterConfigurationException

getUniqueStrings

public Set<String> getUniqueStrings(String propertyName,
 boolean required)
                             throws AppClusterConfigurationException

Gets a unique set of trimmed strings. Must have at least one value when required.

Throws:

AppClusterConfigurationException

getUniqueNames

public Set<? extends Name> getUniqueNames(String propertyName)
                                   throws AppClusterConfigurationException

Gets a unique set of trimmed names. Must have at least one value.

Throws:

AppClusterConfigurationException

isEnabled

public boolean isEnabled()
                  throws AppClusterConfigurationException

Specified by:

isEnabled in interface AppClusterConfiguration

Throws:

AppClusterConfigurationException

See Also:

• AppCluster.isEnabled()

getDisplay

public String getDisplay()
                  throws AppClusterConfigurationException

Specified by:

getDisplay in interface AppClusterConfiguration

Throws:

AppClusterConfigurationException

See Also:

• AppCluster.getDisplay()

getNodeConfigurations

public Set<? extends NodePropertiesConfiguration> getNodeConfigurations()
                                                                 throws AppClusterConfigurationException

Description copied from interface: AppClusterConfiguration

Gets the set of nodes for the cluster.

Specified by:

getNodeConfigurations in interface AppClusterConfiguration

Throws:

AppClusterConfigurationException

getResourceConfigurations

public Set<? extends ResourceConfiguration<?,?>> getResourceConfigurations()
                                                                    throws AppClusterConfigurationException

Description copied from interface: AppClusterConfiguration

Gets the set of resources for the cluster.

Specified by:

getResourceConfigurations in interface AppClusterConfiguration

Throws:

AppClusterConfigurationException