com.cosylab.jcosyne.server
Interface Constants


public interface Constants

This interface contains well-known constants of JCosyne that are used both by clients and servers. These constants relate to configuration properties keys and values, to JMX Notification message types, search criteria keys for ResultRepository and other misc stuff.

Author:
Gasper Tkacik (gasper.tkacik@cosylab.com)

Field Summary
static java.lang.String CLIENT_LOCAL
          If set to true, this forces the client to ignore server location specified in the configuration file and to try to connect to a server running on a local machine.
static java.lang.String CLIENT_PROPS_FILE
          Java system property key for client configuration file location.
static java.lang.String CLIENT_PROPS_LOCATION
          Location of the client properties file in the jar distribution.
static java.lang.String CONFIG_HOME
          Directory under user's home directory that will be opened when the server or client look for the server or client properties file.
static java.lang.String CRITERIA_ID
          Used by ResultRepository when the user does query on all indexed remote task invocations to select a result with a given repository ID.
static java.lang.String CRITERIA_TIMESTAMP
          Used by ResultRepository when the user does query on all indexed remote task invocations to constrain results generated after a specific date.
static java.lang.String CRITERIA_TYPE
          Used by ResultRepository when the user does query on all indexed remote task invocations to constrain results generated by a specific task.
static int DIRECT_ACCESS_MONITOR_TIMER
          The default timer in milliseconds at which the direct access client will poll a monitored attribute.
static java.lang.String JMX_SERVER_NAME_KEY
          Used in both client and server configuration files to denote the name by which the server is exported to the network (RMI registry).
static java.lang.String JMX_SERVER_PORT_KEY
          Used in both client and server configuration files to denote the port number on which the server accepts requests.
static int LOG_LIMIT
          The maximum number of logs kept by the log collector in its log history.
static java.lang.String MESSAGE_LOG
          Used to denote JMX Notification for log as the JMX Notification type string.
static java.lang.String RESULT_REPOSITORY_PATH_KEY
          Used in server configuration file to specify the location of the result repository.
static java.lang.String RESULT_REPOSITORY_RECORDING_KEY
          Used in the server configuration file as a master switch that determines if the result repository is storing data about remote task executions.
static int SERVER_EXIT_ERROR
          The exit code with which the server will terminate if an unrecoverable error is encountered.
static java.lang.String SERVER_HOSTNAME_KEY
          Key used in the client configuration.
static java.lang.String SERVER_PROPS_FILE
          Java system property key for server configuration file location.
static java.lang.String SERVER_PROPS_LOCATION
          Location of the server properties file in the jar distribution.
static java.lang.String SERVER_SHUTDOWN
          Used to denote JMX Notification dispatched by Sentinel to notify the listeners that the server is shutting down.
static long SERVER_SHUTDOWN_SLEEP
          Time in milliseconds that the server shutdown thread will wait before closing all connections after the shutdown signal has been received, for instance from sentinel remote task.
static java.lang.String SYSTEM_PROP_PREFIX
          If in server / client configuration, a property appears that has this string as a prefix of its key (that is if its key begins with this prefix), then system property will be set to the specified value.
 

Field Detail

SERVER_PROPS_LOCATION

public static final java.lang.String SERVER_PROPS_LOCATION
Location of the server properties file in the jar distribution. Properties loaded as resources from server classloader.

See Also:
Constant Field Values

SERVER_PROPS_FILE

public static final java.lang.String SERVER_PROPS_FILE
Java system property key for server configuration file location. If set, the Java properties file from this location will be opened and all available properties will be parsed from here.

See Also:
Constant Field Values

CLIENT_PROPS_FILE

public static final java.lang.String CLIENT_PROPS_FILE
Java system property key for client configuration file location. If set, the Java properties file from this location will be opened and all available properties will be parsed from here.

See Also:
Constant Field Values

CONFIG_HOME

public static final java.lang.String CONFIG_HOME
Directory under user's home directory that will be opened when the server or client look for the server or client properties file. The server config file should be in CONFIG_HOME + separator + SERVER_PROPS_LOCATION. The client config file should be in CONFIG_HOME + separator + CLIENT_PROPS_LOCATION.

See Also:
Constant Field Values

CLIENT_PROPS_LOCATION

public static final java.lang.String CLIENT_PROPS_LOCATION
Location of the client properties file in the jar distribution. Properties loaded as resources from client classloader.

See Also:
Constant Field Values

SERVER_HOSTNAME_KEY

public static final java.lang.String SERVER_HOSTNAME_KEY
Key used in the client configuration. Its value denotes the hostname or IP of the machine hosting the JMX Server. Can be 127.0.0.1 to denote localhost.

See Also:
Constant Field Values

MESSAGE_LOG

public static final java.lang.String MESSAGE_LOG
Used to denote JMX Notification for log as the JMX Notification type string.

See Also:
Constant Field Values

SERVER_SHUTDOWN

public static final java.lang.String SERVER_SHUTDOWN
Used to denote JMX Notification dispatched by Sentinel to notify the listeners that the server is shutting down.

See Also:
Constant Field Values

RESULT_REPOSITORY_RECORDING_KEY

public static final java.lang.String RESULT_REPOSITORY_RECORDING_KEY
Used in the server configuration file as a master switch that determines if the result repository is storing data about remote task executions. The values can be "true" or "false".

See Also:
Constant Field Values

JMX_SERVER_NAME_KEY

public static final java.lang.String JMX_SERVER_NAME_KEY
Used in both client and server configuration files to denote the name by which the server is exported to the network (RMI registry).

See Also:
Constant Field Values

JMX_SERVER_PORT_KEY

public static final java.lang.String JMX_SERVER_PORT_KEY
Used in both client and server configuration files to denote the port number on which the server accepts requests.

See Also:
Constant Field Values

RESULT_REPOSITORY_PATH_KEY

public static final java.lang.String RESULT_REPOSITORY_PATH_KEY
Used in server configuration file to specify the location of the result repository. This location is a path name that will be appended to Java "user.home". It does not start or end with file separator. In this path the result repository will store index file, input and output files.

See Also:
Constant Field Values

CRITERIA_TYPE

public static final java.lang.String CRITERIA_TYPE
Used by ResultRepository when the user does query on all indexed remote task invocations to constrain results generated by a specific task. The value of this criterion is the fully qualified name of the remote task.

See Also:
Constant Field Values

CRITERIA_TIMESTAMP

public static final java.lang.String CRITERIA_TIMESTAMP
Used by ResultRepository when the user does query on all indexed remote task invocations to constrain results generated after a specific date. The value of this criterion is Java long timestamp in milliseconds in the form returned by System.currentTimeMillis in string form.

See Also:
Constant Field Values

CRITERIA_ID

public static final java.lang.String CRITERIA_ID
Used by ResultRepository when the user does query on all indexed remote task invocations to select a result with a given repository ID. The value of this criterion is an integer.

See Also:
Constant Field Values

CLIENT_LOCAL

public static final java.lang.String CLIENT_LOCAL
If set to true, this forces the client to ignore server location specified in the configuration file and to try to connect to a server running on a local machine.

See Also:
Constant Field Values

SERVER_SHUTDOWN_SLEEP

public static final long SERVER_SHUTDOWN_SLEEP
Time in milliseconds that the server shutdown thread will wait before closing all connections after the shutdown signal has been received, for instance from sentinel remote task.

See Also:
Constant Field Values

SERVER_EXIT_ERROR

public static final int SERVER_EXIT_ERROR
The exit code with which the server will terminate if an unrecoverable error is encountered.

See Also:
Constant Field Values

LOG_LIMIT

public static final int LOG_LIMIT
The maximum number of logs kept by the log collector in its log history. If set to -1, the list can grow without bound.

See Also:
Constant Field Values

DIRECT_ACCESS_MONITOR_TIMER

public static final int DIRECT_ACCESS_MONITOR_TIMER
The default timer in milliseconds at which the direct access client will poll a monitored attribute.

See Also:
Constant Field Values

SYSTEM_PROP_PREFIX

public static final java.lang.String SYSTEM_PROP_PREFIX
If in server / client configuration, a property appears that has this string as a prefix of its key (that is if its key begins with this prefix), then system property will be set to the specified value. The key of the Java system property will be the key specified in the configuration minus the prefix.

See Also:
Constant Field Values