org.rhq.enterprise.server.core.comm
Interface ServerConfigurationConstants

public interface ServerConfigurationConstants

These are the names of the known server configuration preferences. All configuration preferences are stored in flat properties (there is no hierarchy - simply a set of name/value pairs).

Author:

John Mazzitelli

Field Summary

static String	AGENT_FILES_DIRECTORY The directory location that contains all files that can be distributed to agents.
static String	CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED Property that indicates if the spool file's data is compressed.
static String	CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME Property that provides the spool file name (as it is found in the data directory).
static String	CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS Property that provides the spool file parameters.
static String	CLIENT_SENDER_COMMAND_TIMEOUT The time in milliseconds that the client sender will wait before aborting a command.
static String	CLIENT_SENDER_MAX_CONCURRENT The maximum number of concurrent commands that can be in the process of being sent at any one time.
static String	CLIENT_SENDER_MAX_RETRIES Number of times a guaranteed message is retried, if it failed for some reason other than a "cannot connect".
static String	CLIENT_SENDER_QUEUE_SIZE The maximum size of the command queue - this is the maximum number of commands that can be queued for sending.
static String	CLIENT_SENDER_QUEUE_THROTTLING If this property is defined, it indicates the queue throttling configuration For example, maximum number of commands per burst, the length of time of each burst period).
static String	CLIENT_SENDER_RETRY_INTERVAL Property that provides the amount of time, in milliseconds, that the sender will pause before attempting to retry a failed command whose delivery is to be guaranteed.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_ALGORITHM The algorithm used to manage the keys in the keystore file.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_ALIAS The alias to the client's key found in the keystore file.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_FILE The path to the keystore file.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_KEY_PASSWORD The password to gain access to the key found in the keystore.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_PASSWORD The password used to access the keystore file.
static String	CLIENT_SENDER_SECURITY_KEYSTORE_TYPE The type of keystore file.
static String	CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE The server authentication mode that, when enabled, forces the server to authenticate the remote agent's certificate with one in the server's trust store.
static String	CLIENT_SENDER_SECURITY_SOCKET_PROTOCOL The secure protocol used by the server's communications layer to the remote agents.
static String	CLIENT_SENDER_SECURITY_TRUSTSTORE_ALGORITHM The algorithm used to manage the keys in the truststore file.
static String	CLIENT_SENDER_SECURITY_TRUSTSTORE_FILE The path to the truststore file.
static String	CLIENT_SENDER_SECURITY_TRUSTSTORE_PASSWORD The password used to access the truststore file.
static String	CLIENT_SENDER_SECURITY_TRUSTSTORE_TYPE The type of truststore file.
static String	CLIENT_SENDER_SEND_THROTTLING If this property is defined, it indicates the send throttling configuration.
static String	CONFIG_SCHEMA_VERSION The configuration schema version.
static int	CURRENT_CONFIG_SCHEMA_VERSION This is the current schema version that our server configuration knows about.
static boolean	DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED If the client sender command spool file compress flag is not specified, this is the default.
static String	DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME If the client sender command spool file name is not specified, this is the default.
static String	DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS If the client sender command spool file parameters are not specified, this is the default.
static long	DEFAULT_CLIENT_SENDER_COMMAND_TIMEOUT If the client sender command timeout is not specified, this is the default.
static int	DEFAULT_CLIENT_SENDER_MAX_CONCURRENT If the client sender max concurrent value is not specified, this is the default.
static int	DEFAULT_CLIENT_SENDER_MAX_RETRIES If the client sender max retries is not specified, this is the default.
static int	DEFAULT_CLIENT_SENDER_QUEUE_SIZE If the client sender queue size is not specified, this is the default.
static long	DEFAULT_CLIENT_SENDER_RETRY_INTERVAL If the client sender retry pause is not specified, this is the default.
static boolean	DEFAULT_CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE If the client sender server auth mode is not specified, this is the default.
static String	DEFAULT_PREFERENCE_NODE This is the name of the preference node under the PREFERENCE_NODE_PARENT where all server configuration is stored by default.
static String	DEFAULT_SERVER_CONFIGURATION_FILE This is the name of the default server configuration file.
static String	PREFERENCE_NODE_PARENT This is the top leve parent node of all server preferences and is directly under the userRoot preferences node.
static String	PROPERTY_NAME_PREFIX The prefix that all server configuration property names start with.

Field Detail

PREFERENCE_NODE_PARENT

static final String PREFERENCE_NODE_PARENT

This is the top leve parent node of all server preferences and is directly under the userRoot preferences node.

See Also:

Constant Field Values

DEFAULT_PREFERENCE_NODE

static final String DEFAULT_PREFERENCE_NODE

This is the name of the preference node under the PREFERENCE_NODE_PARENT where all server configuration is stored by default.

See Also:

Constant Field Values

DEFAULT_SERVER_CONFIGURATION_FILE

static final String DEFAULT_SERVER_CONFIGURATION_FILE

This is the name of the default server configuration file.

See Also:

Constant Field Values

PROPERTY_NAME_PREFIX

static final String PROPERTY_NAME_PREFIX

The prefix that all server configuration property names start with.

See Also:

Constant Field Values

CONFIG_SCHEMA_VERSION

static final String CONFIG_SCHEMA_VERSION

The configuration schema version.

See Also:

Constant Field Values

CURRENT_CONFIG_SCHEMA_VERSION

static final int CURRENT_CONFIG_SCHEMA_VERSION

This is the current schema version that our server configuration knows about.

See Also:

Constant Field Values

AGENT_FILES_DIRECTORY

static final String AGENT_FILES_DIRECTORY

The directory location that contains all files that can be distributed to agents.

See Also:

Constant Field Values

CLIENT_SENDER_QUEUE_SIZE

static final String CLIENT_SENDER_QUEUE_SIZE

The maximum size of the command queue - this is the maximum number of commands that can be queued for sending.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_QUEUE_SIZE

static final int DEFAULT_CLIENT_SENDER_QUEUE_SIZE

If the client sender queue size is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_MAX_CONCURRENT

static final String CLIENT_SENDER_MAX_CONCURRENT

The maximum number of concurrent commands that can be in the process of being sent at any one time.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_MAX_CONCURRENT

static final int DEFAULT_CLIENT_SENDER_MAX_CONCURRENT

If the client sender max concurrent value is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_COMMAND_TIMEOUT

static final String CLIENT_SENDER_COMMAND_TIMEOUT

The time in milliseconds that the client sender will wait before aborting a command. This is the amount of time in milliseconds that the server has in order to process commands. A command can override this by setting its own timeout in the command's configuration.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_COMMAND_TIMEOUT

static final long DEFAULT_CLIENT_SENDER_COMMAND_TIMEOUT

If the client sender command timeout is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_SEND_THROTTLING

static final String CLIENT_SENDER_SEND_THROTTLING

If this property is defined, it indicates the send throttling configuration. For example, maximum number of commands before a quiet period must begin, the length of time of each quiet period).

See Also:

Constant Field Values

CLIENT_SENDER_QUEUE_THROTTLING

static final String CLIENT_SENDER_QUEUE_THROTTLING

If this property is defined, it indicates the queue throttling configuration For example, maximum number of commands per burst, the length of time of each burst period).

See Also:

Constant Field Values

CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME

static final String CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME

Property that provides the spool file name (as it is found in the data directory).

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME

static final String DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_NAME

If the client sender command spool file name is not specified, this is the default. A null value means by default, the server has guaranteed delivery disabled.

CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS

static final String CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS

Property that provides the spool file parameters.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS

static final String DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_PARAMS

If the client sender command spool file parameters are not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED

static final String CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED

Property that indicates if the spool file's data is compressed.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED

static final boolean DEFAULT_CLIENT_SENDER_COMMAND_SPOOL_FILE_COMPRESSED

If the client sender command spool file compress flag is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_RETRY_INTERVAL

static final String CLIENT_SENDER_RETRY_INTERVAL

Property that provides the amount of time, in milliseconds, that the sender will pause before attempting to retry a failed command whose delivery is to be guaranteed.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_RETRY_INTERVAL

static final long DEFAULT_CLIENT_SENDER_RETRY_INTERVAL

If the client sender retry pause is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_MAX_RETRIES

static final String CLIENT_SENDER_MAX_RETRIES

Number of times a guaranteed message is retried, if it failed for some reason other than a "cannot connect". If it cannot connect, it always retries and this is ignored.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_MAX_RETRIES

static final int DEFAULT_CLIENT_SENDER_MAX_RETRIES

If the client sender max retries is not specified, this is the default.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_SOCKET_PROTOCOL

static final String CLIENT_SENDER_SECURITY_SOCKET_PROTOCOL

The secure protocol used by the server's communications layer to the remote agents.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_ALIAS

static final String CLIENT_SENDER_SECURITY_KEYSTORE_ALIAS

The alias to the client's key found in the keystore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_FILE

static final String CLIENT_SENDER_SECURITY_KEYSTORE_FILE

The path to the keystore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_ALGORITHM

static final String CLIENT_SENDER_SECURITY_KEYSTORE_ALGORITHM

The algorithm used to manage the keys in the keystore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_TYPE

static final String CLIENT_SENDER_SECURITY_KEYSTORE_TYPE

The type of keystore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_PASSWORD

static final String CLIENT_SENDER_SECURITY_KEYSTORE_PASSWORD

The password used to access the keystore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_KEYSTORE_KEY_PASSWORD

static final String CLIENT_SENDER_SECURITY_KEYSTORE_KEY_PASSWORD

The password to gain access to the key found in the keystore.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_TRUSTSTORE_FILE

static final String CLIENT_SENDER_SECURITY_TRUSTSTORE_FILE

The path to the truststore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_TRUSTSTORE_ALGORITHM

static final String CLIENT_SENDER_SECURITY_TRUSTSTORE_ALGORITHM

The algorithm used to manage the keys in the truststore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_TRUSTSTORE_TYPE

static final String CLIENT_SENDER_SECURITY_TRUSTSTORE_TYPE

The type of truststore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_TRUSTSTORE_PASSWORD

static final String CLIENT_SENDER_SECURITY_TRUSTSTORE_PASSWORD

The password used to access the truststore file.

See Also:

Constant Field Values

CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE

static final String CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE

The server authentication mode that, when enabled, forces the server to authenticate the remote agent's certificate with one in the server's trust store. If false, no server authentication is performed; any remote agent is allowed to communicate with the server.

See Also:

Constant Field Values

DEFAULT_CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE

static final boolean DEFAULT_CLIENT_SENDER_SECURITY_SERVER_AUTH_MODE

If the client sender server auth mode is not specified, this is the default.

See Also:

Constant Field Values