org.jppf.utils

Class JPPFConfiguration

java.lang.Object

org.jppf.utils.JPPFConfiguration

public final class JPPFConfiguration
extends Object

Utility class for loading and accessing the JPPF configuration properties.

The configuration file path is set through the system property CONFIG_PROPERTY, whose value is "jppf.config".
As an example, it can be configured by adding the JVM argument "-Djppf.config=jppf-config.properties".

Modified to allow users to get configuration properties from an alternate source. Any user-provided class that implements JPPFConfiguration.ConfigurationSource and returns a stream with the same configuration values provided in the properties file.
The configuration source must then configured via the system property -Djppf.config.plugin = mypackage.MyConfigurationSource"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JPPFConfiguration.ConfigurationSource Implement this interface to provide an alternate configuration source via an InputStream.
static interface	JPPFConfiguration.ConfigurationSourceReader Implement this interface to provide an alternate configuration source via a Reader.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PLUGIN_PROPERTY The name of the system property used to specified an alternate JPPF configuration source.
static String	CONFIG_PROPERTY Name of the system property holding the location of the JPPF configuration file.
static String	DEFAULT_FILE Default location of the JPPF configuration file.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	get(JPPFProperty<T> property) Get the value of a predefined property.
static TypedProperties	getProperties() Get the configuration properties.
static <T> T	remove(JPPFProperty<T> property) Remove the predefined property.
static void	reset() Reset and reload the JPPF configuration.
static <T> TypedProperties	set(JPPFProperty<T> property, T value) Set the value of a predefined property.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROPERTY

public static final String CONFIG_PROPERTY

Name of the system property holding the location of the JPPF configuration file.

See Also:

Constant Field Values

CONFIG_PLUGIN_PROPERTY

public static final String CONFIG_PLUGIN_PROPERTY

The name of the system property used to specified an alternate JPPF configuration source.

See Also:

Constant Field Values

DEFAULT_FILE

public static final String DEFAULT_FILE

Default location of the JPPF configuration file.

See Also:

Constant Field Values

Method Detail

getProperties

public static TypedProperties getProperties()

Get the configuration properties.

Returns:

a TypedProperties instance.

get

public static <T> T get(JPPFProperty<T> property)

Get the value of a predefined property. This is the same as calling JPPFConfiguration.getProperties().get(property).

Type Parameters:

T - the type of the property.

Parameters:

property - the property whose value to retrieve.

Returns:

the value of the property according to its type.

set

public static <T> TypedProperties set(JPPFProperty<T> property,
                      T value)

Set the value of a predefined property. This is the same as calling JPPFConfiguration.getProperties().set(property, value).

Type Parameters:

T - the type of the property.

Parameters:

property - the property whose value to set.

value - the value to set.

Returns:

the TypedProperties instance in which the value is set.

remove

public static <T> T remove(JPPFProperty<T> property)

Remove the predefined property. This is the same as calling JPPFConfiguration.getProperties().remove(property).

Type Parameters:

T - the type of the property.

Parameters:

property - the property whose value to retrieve.

Returns:

the value of the property according to its type.

reset

public static void reset()

Reset and reload the JPPF configuration. This allows reloading the configuration from a different source or file (after changing the values of the related system properties for instance).