de.aristaflow.adept2.base.configuration

Class ConfigurationConstants

java.lang.Object

de.aristaflow.adept2.base.configuration.ConfigurationConstants

public final class ConfigurationConstants
extends java.lang.Object

Configuration-related global constants for general use in configuration files.

Author:

Kevin Goeser, Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationConstants.CommunicationProtocol The names for all supported communication protocols (which are equal to the instance names of the corresponding communication services).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_PATH_SEPARATOR The separator for multi-valued class paths.
static java.lang.String	COMPONENT_TYPE_CONSOLE_LOGGER The name of the component type for console logging.
static java.lang.String	COMPONENT_TYPE_FILE_LOGGER The name of the component type for file logging.
static java.lang.String	CONFIG_CONFIGURATION_MANAGER The prefix for the configuration of the configuration manager.
static java.lang.String	CONFIG_DIRECTORY The name of the directory where usually all configurations are stored.
static java.lang.String	CONFIG_FILE_BOOT The configuration file for booting and initialising bootstrap configuration manager, logging, and registry.
static java.lang.String	CONFIG_FILE_EXTENSION The file extension used for all configuration files
static java.lang.String	CONFIG_PREFIX_RESOLVED_VARIABLES The prefix for configuration values that contain variables that are to be resolved when loading the configuration.
static java.lang.String	CONFIG_PROVIDED_POSITION The string identifying the position in the configuration directories/URLs where to apply a provided configuration.
static java.lang.String	CONFIG_TERMINATION_SYSTEM_EXIT_SECONDS The property name for performing a System.exit() if termination does not succeed.
static java.lang.String	CONFIG_TERMINATION_THREAD_DUMP_INTERVAL_SECONDS The property name for performing a thread dump in the given interval during termination
static java.lang.String	CONFIGURATION_RUNTIME_DB_COLUMN_KEY The column name for keys of runtime configuration tables.
static java.lang.String	CONFIGURATION_RUNTIME_DB_COLUMN_VALUE The column name for values of runtime configuration tables.
static java.lang.String	CONFIGURATION_RUNTIME_DB_TABLE_PREFIX The prefix for the table names for runtime configuration tables.
static java.lang.String	CONFIGURATION_VARIABLE The prefix for the definition of configuration variables defined in the configuration itself.
static java.lang.String	EXTENSIONS_DIR The directory name that should be used for jar outputs (WSDL and Java imports).
static java.lang.String	LOGGER_CONFIGURATION_CSV_MODE The configuration key for the CSV mode of a file logger.
static java.lang.String	LOGGER_CONFIGURATION_FILE_COUNT The configuration key for the amount of log files.
static java.lang.String	LOGGER_CONFIGURATION_FILE_SIZE The configuration key for size of a log file.
static java.lang.String	LOGGER_CONFIGURATION_FILTER The configuration key for the filter of a logger.
static java.lang.String	LOGGER_CONFIGURATION_LEVEL The configuration key for the level of a logger or a filter.
static java.lang.String	LOGGER_CONFIGURATION_LOG_DIRECTORY The configuration key for the directory of a file logger.
static java.lang.String	LOGGER_CONFIGURATION_LOG_EXTENSION The file extension for file logs.
static java.lang.String	LOGGER_CONFIGURATION_ROOT The configuration key for the root of a logger or a filter.
static java.lang.String	PREFIX_PROPERTY_LOGGING The prefix for the logging configuration.
static java.lang.String	PREFIX_PROPERTY_REGISTRY_INSTANCES The prefix for declaring component instances managed by a registry.
static java.lang.String	PREFIX_PROPERTY_REGISTRY_TYPES The prefix for the component types managed by a registry.
static java.lang.String	PROPERTY_CLUSTER_NAME The property name for the cluster name of a server or client.
static java.lang.String	PROPERTY_CONFIGURATION_FILE The property name for separate configuration files.
static java.lang.String	PROPERTY_CONFIGURATION_RUNTIME_DATA_SOURCE The property name for runtime configuration files/directories.
static java.lang.String	PROPERTY_CONFIGURATION_RUNTIME_FILE The property name for runtime configuration files/directories.
static java.lang.String	PROPERTY_CONFIGURATION_RUNTIME_PREFIX The prefix for runtime configuration files/directories or data sources.
static java.lang.String	PROPERTY_FOREIGN_CLUSTERS The property name for the names of the foreign clusters that will be removed from the database, e. g. since the database has been copied from one of these clusters.
static java.lang.String	PROPERTY_FOREIGN_CLUSTERS_LAST_UPDATE_SECONDS The property name for the last update milliseconds which must have elapsed for foreign clusters to be removed from the database, e. g. since the database has been copied from one of these clusters.
static java.lang.String	PROPERTY_INSTANCE_NAME The property name for the instance name of a server or client.
static java.lang.String	PROPERTY_REGISTRY_CLASSPATH The property name for the classpath of a specific component/plugin instance.
static java.lang.String	PROPERTY_REGISTRY_IMPLEMENTATION The property name for the implementing class of a component type.
static java.lang.String	PROPERTY_REGISTRY_INSTANTIATION_MODE The property name for the instantiation mode for a component instance.
static java.lang.String	PROPERTY_REGISTRY_PLUGIN_CLASSPATH The property name for the path where to look initially for plugins, this is the classpath of the plugin type.
static java.lang.String	PROPERTY_REGISTRY_PLUGIN_TYPES The property name for the plugin types an instance can use.
static java.lang.String	PROPERTY_REGISTRY_SERVICE_URI The property name for the service URI of a component instance.
static java.lang.String	PROPERTY_URI The property name for the (symbolic) URI of a server or client.
static java.lang.String	SERVICE_AUTOSTART_SERVICES The name of the property for the (simple) service names to start at startup.
static java.lang.String	SERVICE_EXPORT_VIA The simple instance names, a service will be exported with.
static java.lang.String	SERVICE_MULTI_THREAD_SERVICE_START_POOL_SIZE The name of the property to configure the amount of threads used for multi-threaded service starting.
static java.lang.String	SERVICE_PUBLISH_SERVICE Whether the service is to be published at the global registry.

Constructor Summary

Constructors

Constructor and Description
ConfigurationConstants()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getConfigurationBundleRoot(java.lang.String subDir) The path of the root configuration file within the bundle configuration (JAR-file) which has to be present to identify a bundle as configuration bundle.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_PATH_SEPARATOR

public static final java.lang.String CLASS_PATH_SEPARATOR

The separator for multi-valued class paths. File.pathSeparator cannot be used here since it depends on the running platform and we want the configuration files to be platform-independent. This is also the reason for not using ":". ;-)

See Also:

Constant Field Values

CONFIG_FILE_EXTENSION

public static final java.lang.String CONFIG_FILE_EXTENSION

The file extension used for all configuration files

See Also:

Constant Field Values

CONFIG_FILE_BOOT

public static final java.lang.String CONFIG_FILE_BOOT

The configuration file for booting and initialising bootstrap configuration manager, logging, and registry.

See Also:

Constant Field Values

CONFIG_DIRECTORY

public static final java.lang.String CONFIG_DIRECTORY

The name of the directory where usually all configurations are stored.

See Also:

Constant Field Values

CONFIG_PROVIDED_POSITION

public static final java.lang.String CONFIG_PROVIDED_POSITION

The string identifying the position in the configuration directories/URLs where to apply a provided configuration.

See Also:

Constant Field Values

PROPERTY_CLUSTER_NAME

public static final java.lang.String PROPERTY_CLUSTER_NAME

The property name for the cluster name of a server or client.

See Also:

Constant Field Values

PROPERTY_FOREIGN_CLUSTERS_LAST_UPDATE_SECONDS

public static final java.lang.String PROPERTY_FOREIGN_CLUSTERS_LAST_UPDATE_SECONDS

The property name for the last update milliseconds which must have elapsed for foreign clusters to be removed from the database, e. g. since the database has been copied from one of these clusters.

See Also:

Constant Field Values

PROPERTY_FOREIGN_CLUSTERS

public static final java.lang.String PROPERTY_FOREIGN_CLUSTERS

The property name for the names of the foreign clusters that will be removed from the database, e. g. since the database has been copied from one of these clusters.

See Also:

Constant Field Values

PROPERTY_INSTANCE_NAME

public static final java.lang.String PROPERTY_INSTANCE_NAME

The property name for the instance name of a server or client.

See Also:

Constant Field Values

PROPERTY_URI

public static final java.lang.String PROPERTY_URI

The property name for the (symbolic) URI of a server or client.

See Also:

Constant Field Values

CONFIG_TERMINATION_THREAD_DUMP_INTERVAL_SECONDS

public static final java.lang.String CONFIG_TERMINATION_THREAD_DUMP_INTERVAL_SECONDS

The property name for performing a thread dump in the given interval during termination

See Also:

Constant Field Values

CONFIG_TERMINATION_SYSTEM_EXIT_SECONDS

public static final java.lang.String CONFIG_TERMINATION_SYSTEM_EXIT_SECONDS

The property name for performing a System.exit() if termination does not succeed.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_FILE

public static final java.lang.String PROPERTY_CONFIGURATION_FILE

The property name for separate configuration files.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_RUNTIME_PREFIX

public static final java.lang.String PROPERTY_CONFIGURATION_RUNTIME_PREFIX

The prefix for runtime configuration files/directories or data sources.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_RUNTIME_FILE

public static final java.lang.String PROPERTY_CONFIGURATION_RUNTIME_FILE

The property name for runtime configuration files/directories.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_RUNTIME_DATA_SOURCE

public static final java.lang.String PROPERTY_CONFIGURATION_RUNTIME_DATA_SOURCE

The property name for runtime configuration files/directories.

See Also:

BaseConstants.COMPONENT_TYPE_JDBC_DATA_SOURCE, Constant Field Values

PROPERTY_REGISTRY_IMPLEMENTATION

public static final java.lang.String PROPERTY_REGISTRY_IMPLEMENTATION

The property name for the implementing class of a component type.

See Also:

Constant Field Values

PROPERTY_REGISTRY_INSTANTIATION_MODE

public static final java.lang.String PROPERTY_REGISTRY_INSTANTIATION_MODE

The property name for the instantiation mode for a component instance.

See Also:

Constant Field Values

PROPERTY_REGISTRY_CLASSPATH

public static final java.lang.String PROPERTY_REGISTRY_CLASSPATH

The property name for the classpath of a specific component/plugin instance.

See Also:

Constant Field Values

PROPERTY_REGISTRY_PLUGIN_TYPES

public static final java.lang.String PROPERTY_REGISTRY_PLUGIN_TYPES

The property name for the plugin types an instance can use.

See Also:

Constant Field Values

PROPERTY_REGISTRY_PLUGIN_CLASSPATH

public static final java.lang.String PROPERTY_REGISTRY_PLUGIN_CLASSPATH

The property name for the path where to look initially for plugins, this is the classpath of the plugin type.

See Also:

Constant Field Values

PROPERTY_REGISTRY_SERVICE_URI

public static final java.lang.String PROPERTY_REGISTRY_SERVICE_URI

The property name for the service URI of a component instance.

See Also:

Constant Field Values

COMPONENT_TYPE_CONSOLE_LOGGER

public static final java.lang.String COMPONENT_TYPE_CONSOLE_LOGGER

The name of the component type for console logging.

See Also:

Constant Field Values

COMPONENT_TYPE_FILE_LOGGER

public static final java.lang.String COMPONENT_TYPE_FILE_LOGGER

The name of the component type for file logging.

See Also:

Constant Field Values

PREFIX_PROPERTY_REGISTRY_TYPES

public static final java.lang.String PREFIX_PROPERTY_REGISTRY_TYPES

The prefix for the component types managed by a registry.

See Also:

Constant Field Values

PREFIX_PROPERTY_REGISTRY_INSTANCES

public static final java.lang.String PREFIX_PROPERTY_REGISTRY_INSTANCES

The prefix for declaring component instances managed by a registry.

See Also:

Constant Field Values

PREFIX_PROPERTY_LOGGING

public static final java.lang.String PREFIX_PROPERTY_LOGGING

The prefix for the logging configuration.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_LEVEL

public static final java.lang.String LOGGER_CONFIGURATION_LEVEL

The configuration key for the level of a logger or a filter.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_ROOT

public static final java.lang.String LOGGER_CONFIGURATION_ROOT

The configuration key for the root of a logger or a filter.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_LOG_DIRECTORY

public static final java.lang.String LOGGER_CONFIGURATION_LOG_DIRECTORY

The configuration key for the directory of a file logger.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_LOG_EXTENSION

public static final java.lang.String LOGGER_CONFIGURATION_LOG_EXTENSION

The file extension for file logs.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_FILE_SIZE

public static final java.lang.String LOGGER_CONFIGURATION_FILE_SIZE

The configuration key for size of a log file.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_FILE_COUNT

public static final java.lang.String LOGGER_CONFIGURATION_FILE_COUNT

The configuration key for the amount of log files.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_CSV_MODE

public static final java.lang.String LOGGER_CONFIGURATION_CSV_MODE

The configuration key for the CSV mode of a file logger.

See Also:

Constant Field Values

LOGGER_CONFIGURATION_FILTER

public static final java.lang.String LOGGER_CONFIGURATION_FILTER

The configuration key for the filter of a logger.

See Also:

Constant Field Values

CONFIG_CONFIGURATION_MANAGER

public static final java.lang.String CONFIG_CONFIGURATION_MANAGER

The prefix for the configuration of the configuration manager.

See Also:

Constant Field Values

CONFIG_PREFIX_RESOLVED_VARIABLES

public static final java.lang.String CONFIG_PREFIX_RESOLVED_VARIABLES

The prefix for configuration values that contain variables that are to be resolved when loading the configuration.

See Also:

Constant Field Values

CONFIGURATION_VARIABLE

public static final java.lang.String CONFIGURATION_VARIABLE

The prefix for the definition of configuration variables defined in the configuration itself. This is used for defining as well as accessing the variables.

See Also:

Constant Field Values

CONFIGURATION_RUNTIME_DB_TABLE_PREFIX

public static final java.lang.String CONFIGURATION_RUNTIME_DB_TABLE_PREFIX

The prefix for the table names for runtime configuration tables.

See Also:

Constant Field Values

CONFIGURATION_RUNTIME_DB_COLUMN_KEY

public static final java.lang.String CONFIGURATION_RUNTIME_DB_COLUMN_KEY

The column name for keys of runtime configuration tables.

See Also:

Constant Field Values

CONFIGURATION_RUNTIME_DB_COLUMN_VALUE

public static final java.lang.String CONFIGURATION_RUNTIME_DB_COLUMN_VALUE

The column name for values of runtime configuration tables.

See Also:

Constant Field Values

SERVICE_EXPORT_VIA

public static final java.lang.String SERVICE_EXPORT_VIA

The simple instance names, a service will be exported with.

See Also:

Constant Field Values

SERVICE_PUBLISH_SERVICE

public static final java.lang.String SERVICE_PUBLISH_SERVICE

Whether the service is to be published at the global registry.

See Also:

Constant Field Values

SERVICE_AUTOSTART_SERVICES

public static final java.lang.String SERVICE_AUTOSTART_SERVICES

The name of the property for the (simple) service names to start at startup.

See Also:

Constant Field Values

SERVICE_MULTI_THREAD_SERVICE_START_POOL_SIZE

public static final java.lang.String SERVICE_MULTI_THREAD_SERVICE_START_POOL_SIZE

The name of the property to configure the amount of threads used for multi-threaded service starting.

See Also:

Constant Field Values

EXTENSIONS_DIR

public static final java.lang.String EXTENSIONS_DIR

The directory name that should be used for jar outputs (WSDL and Java imports).
This is kind of ugly since it relies on a hierarchical file system and therefore this may be changed in the future.

See Also:

Constant Field Values

Constructor Detail

ConfigurationConstants

public ConfigurationConstants()

Method Detail

getConfigurationBundleRoot

public static java.lang.String getConfigurationBundleRoot(java.lang.String subDir)

The path of the root configuration file within the bundle configuration (JAR-file) which has to be present to identify a bundle as configuration bundle.

Parameters:

subDir - The subdirectory below "conf/" where to look for the root configuration file ("ADEPT2.properties"). This must not be null.

Returns:

The path to the root configuration file within a bundle configuration to identify the bundle as configuration bundle.