RASConstants (IBM WebSphere Application Server [ras])

com.ibm.ras
Interface RASConstants

All Known Implementing Classes:
RASEvent, RASLogger, RASObject

public interface RASConstants

RASConstants defines a set of constants used by the RAS Toolkit.

Field Summary

static java.lang.String KEY_CLASS_NAME
          A key used to access a RAS object configuration value: the name of the class the RASManager must instantiate to create an object.

static java.lang.String KEY_CLIENT
          A key used to access a RAS object configuration value: the client name that the RASMessageLogger associates with a logged message.

static java.lang.String KEY_COMPONENT
          A key used to access a RAS object configuration value: the component name that the RASMessageLogger associates with a logged message.

static java.lang.String KEY_DATE_FORMAT
          A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a date.

static java.lang.String KEY_DEFAULT_HANDLERS
          A key used to access a RAS object configuration value: the default handlers that may be attached to any message or trace logger.

static java.lang.String KEY_DEFAULT_MESSAGE_HANDLERS
          A key used to access a RAS object configuration value: the default handlers that may be attached to any message logger.

static java.lang.String KEY_DEFAULT_TRACE_HANDLERS
          A key used to access a RAS object configuration value: the default handlers that may be attached to any trace logger.

static java.lang.String KEY_DESCRIPTION
          A key used to access a RAS object configuration value: the description of any RASObject.

static java.lang.String KEY_ENCODING
          A key used to access a RAS object configuration value: the encoding (code page) to be used by the RASFileHandler.

static java.lang.String KEY_EXCEPTION
          A key used to access a RAS object configuration value: an Exception in a RAS message.

static java.lang.String KEY_EXCEPTION_TRACE
          A key used to access a RAS object configuration value: the stack trace from an Exception in a RAS message.

static java.lang.String KEY_FILE_NAME
          A key used to access a RAS object configuration value: the file used by the RASFileHandler.

static java.lang.String KEY_FORMATTER_NAMES
          A key used to access a RAS object configuration value: the names of the formatters attached to a RASHandler.

static java.lang.String KEY_GROUP
          A key used to access a RAS object configuration value: the RAS group of which a RAS object is a member.

static java.lang.String KEY_HANDLER_NAMES
          A key used to access a RAS object configuration value: the names of the handlers attached to a RASLogger.

static java.lang.String KEY_HEX_DATA
          A key used to access a RAS object configuration value: an array of bytes to be traced.

static java.lang.String KEY_IS_CIRCULAR
          A key used to access a RAS object configuration value: whether a RASHandler is using a circular buffer.

static java.lang.String KEY_IS_LOGGING
          A key used to access a RAS object configuration value: the state of a RASLogger (on/off).

static java.lang.String KEY_IS_SYNC
          A key used to access a RAS object configuration value: whether a RASLogger is logging synchronously.

static java.lang.String KEY_LOGGER
          A key used to access a RAS object configuration value: the name of the RASTraceLogger placed in a trace record.

static java.lang.String KEY_LOGGING_CLASS
          A key used to access a RAS object configuration value: the name of the class which logged a RAS event.

static java.lang.String KEY_LOGGING_METHOD
          A key used to access a RAS object configuration value: the name of the method which logged a RAS event.

static java.lang.String KEY_MAX_FILE_SIZE
          A key used to access a RAS object configuration value: the maximum size, in kilobytes, of each log file used by the RASMultiFileHandler.

static java.lang.String KEY_MAX_FILES
          A key used to access a RAS object configuration value: the maximum number of files which a RASMultiFileHandler will use to hold log data.

static java.lang.String KEY_MAX_QUEUE_SIZE
          A key used to access a RAS object configuration value: the maximum number of RASIEvents which a RASHandler will hold.

static java.lang.String KEY_MESSAGE_EVENT_CLASSES
          A key used to access a RAS object configuration value: the set of message event classes used by a RASLogger.

static java.lang.String KEY_MESSAGE_FILE
          A key used to access a RAS object configuration value: a message file name, used by the RASMessageLogger to translate message keys.

static java.lang.String KEY_MESSAGE_MASK
          A key used to access a RAS object configuration value: the message mask used by a RASMessageLogger and the RASHandler.

static java.lang.String KEY_NAME
          A key used to access a RAS object configuration value: the name of any RASObject.

static java.lang.String KEY_ORGANIZATION
          A key used to access a RAS object configuration value: the organization name that the RASMessageLogger associates with a logged message.

static java.lang.String KEY_PRODUCT
          A key used to access a RAS object configuration value: the product name that the RASMessageLogger associates with a logged message.

static java.lang.String KEY_RETRY_INTERVAL
          A key used to access a RAS object configuration value: the number of milliseconds that a RASHandler will wait before retrying a failed write.

static java.lang.String KEY_SEPARATOR
          A key used to access a RAS object configuration value: the string used by the RASFormatter class to separate fields in the formatted output.

static java.lang.String KEY_SERVER
          A key used to access a RAS object configuration value: the server name that the RASMessageLogger associates with a logged message.

static java.lang.String KEY_SOCKET_PORT
          A key used to access a RAS object configuration value: the port used by the RASSocketHandler.

static java.lang.String KEY_SOCKET_SERVER
          A key used to access a RAS object configuration value: the name of the server to which the RASSocketHandler will connect.

static java.lang.String KEY_SUPPRESSED_KEYS
          A key used to access a RAS object configuration value: the message keys which the RASMessageLogger will not display.

static java.lang.String KEY_THREAD_ID
          A key used to access a RAS object configuration value: the thread associated with trace data.

static java.lang.String KEY_TIME_FORMAT
          A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a time.

static java.lang.String KEY_TRACE_EVENT_CLASSES
          A key used to access a RAS object configuration value: the set of trace event classes used by a RASLogger.

static java.lang.String KEY_TRACE_MASK
          A key used to access a RAS object configuration value: the trace mask used by a RASTraceLogger and the RASHandler.

static java.lang.String RAS_VERSION
          The current version of the RAS Toolkit.

Field Detail

RAS_VERSION
public static final java.lang.String RAS_VERSION
The current version of the RAS Toolkit.

See Also:
Constant Field Values

KEY_CLASS_NAME
public static final java.lang.String KEY_CLASS_NAME
A key used to access a RAS object configuration value: the name of the class the RASManager must instantiate to create an object.

See Also:
Constant Field Values

KEY_CLIENT
public static final java.lang.String KEY_CLIENT
A key used to access a RAS object configuration value: the client name that the RASMessageLogger associates with a logged message.

See Also:
Constant Field Values

KEY_COMPONENT
public static final java.lang.String KEY_COMPONENT
A key used to access a RAS object configuration value: the component name that the RASMessageLogger associates with a logged message.

See Also:
Constant Field Values

KEY_DESCRIPTION
public static final java.lang.String KEY_DESCRIPTION
A key used to access a RAS object configuration value: the description of any RASObject.

See Also:
Constant Field Values

KEY_DATE_FORMAT
public static final java.lang.String KEY_DATE_FORMAT
A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a date.

See Also:
Constant Field Values

KEY_DEFAULT_HANDLERS
public static final java.lang.String KEY_DEFAULT_HANDLERS
A key used to access a RAS object configuration value: the default handlers that may be attached to any message or trace logger.

See Also:
Constant Field Values

KEY_DEFAULT_MESSAGE_HANDLERS
public static final java.lang.String KEY_DEFAULT_MESSAGE_HANDLERS
A key used to access a RAS object configuration value: the default handlers that may be attached to any message logger.

See Also:
Constant Field Values

KEY_DEFAULT_TRACE_HANDLERS
public static final java.lang.String KEY_DEFAULT_TRACE_HANDLERS
A key used to access a RAS object configuration value: the default handlers that may be attached to any trace logger.

See Also:
Constant Field Values

KEY_ENCODING
public static final java.lang.String KEY_ENCODING
A key used to access a RAS object configuration value: the encoding (code page) to be used by the RASFileHandler.

See Also:
Constant Field Values

KEY_EXCEPTION
public static final java.lang.String KEY_EXCEPTION
A key used to access a RAS object configuration value: an Exception in a RAS message.

See Also:
Constant Field Values

KEY_EXCEPTION_TRACE
public static final java.lang.String KEY_EXCEPTION_TRACE
A key used to access a RAS object configuration value: the stack trace from an Exception in a RAS message.

See Also:
Constant Field Values

KEY_FILE_NAME
public static final java.lang.String KEY_FILE_NAME
A key used to access a RAS object configuration value: the file used by the RASFileHandler.

See Also:
Constant Field Values

KEY_FORMATTER_NAMES
public static final java.lang.String KEY_FORMATTER_NAMES
A key used to access a RAS object configuration value: the names of the formatters attached to a RASHandler.

See Also:
Constant Field Values

KEY_GROUP
public static final java.lang.String KEY_GROUP
A key used to access a RAS object configuration value: the RAS group of which a RAS object is a member.

See Also:
Constant Field Values

KEY_HANDLER_NAMES
public static final java.lang.String KEY_HANDLER_NAMES
A key used to access a RAS object configuration value: the names of the handlers attached to a RASLogger.

See Also:
Constant Field Values

KEY_HEX_DATA
public static final java.lang.String KEY_HEX_DATA
A key used to access a RAS object configuration value: an array of bytes to be traced.

See Also:
Constant Field Values

KEY_IS_CIRCULAR
public static final java.lang.String KEY_IS_CIRCULAR
A key used to access a RAS object configuration value: whether a RASHandler is using a circular buffer.

See Also:
Constant Field Values

KEY_IS_LOGGING
public static final java.lang.String KEY_IS_LOGGING
A key used to access a RAS object configuration value: the state of a RASLogger (on/off).

See Also:
Constant Field Values

KEY_IS_SYNC
public static final java.lang.String KEY_IS_SYNC
A key used to access a RAS object configuration value: whether a RASLogger is logging synchronously.

See Also:
Constant Field Values

KEY_LOGGER
public static final java.lang.String KEY_LOGGER
A key used to access a RAS object configuration value: the name of the RASTraceLogger placed in a trace record.

See Also:
Constant Field Values

KEY_LOGGING_CLASS
public static final java.lang.String KEY_LOGGING_CLASS
A key used to access a RAS object configuration value: the name of the class which logged a RAS event.

See Also:
Constant Field Values

KEY_LOGGING_METHOD
public static final java.lang.String KEY_LOGGING_METHOD
A key used to access a RAS object configuration value: the name of the method which logged a RAS event.

See Also:
Constant Field Values

KEY_MAX_FILES
public static final java.lang.String KEY_MAX_FILES
A key used to access a RAS object configuration value: the maximum number of files which a RASMultiFileHandler will use to hold log data.

See Also:
Constant Field Values

KEY_MAX_FILE_SIZE
public static final java.lang.String KEY_MAX_FILE_SIZE
A key used to access a RAS object configuration value: the maximum size, in kilobytes, of each log file used by the RASMultiFileHandler.

See Also:
Constant Field Values

KEY_MAX_QUEUE_SIZE
public static final java.lang.String KEY_MAX_QUEUE_SIZE
A key used to access a RAS object configuration value: the maximum number of RASIEvents which a RASHandler will hold.

See Also:
Constant Field Values

KEY_MESSAGE_EVENT_CLASSES
public static final java.lang.String KEY_MESSAGE_EVENT_CLASSES
A key used to access a RAS object configuration value: the set of message event classes used by a RASLogger.

See Also:
Constant Field Values

KEY_MESSAGE_MASK
public static final java.lang.String KEY_MESSAGE_MASK
A key used to access a RAS object configuration value: the message mask used by a RASMessageLogger and the RASHandler.

See Also:
Constant Field Values

KEY_MESSAGE_FILE
public static final java.lang.String KEY_MESSAGE_FILE
A key used to access a RAS object configuration value: a message file name, used by the RASMessageLogger to translate message keys.

See Also:
Constant Field Values

KEY_NAME
public static final java.lang.String KEY_NAME
A key used to access a RAS object configuration value: the name of any RASObject.

See Also:
Constant Field Values

KEY_ORGANIZATION
public static final java.lang.String KEY_ORGANIZATION
A key used to access a RAS object configuration value: the organization name that the RASMessageLogger associates with a logged message.

See Also:
Constant Field Values

KEY_PRODUCT
public static final java.lang.String KEY_PRODUCT
A key used to access a RAS object configuration value: the product name that the RASMessageLogger associates with a logged message.

See Also:
Constant Field Values

KEY_RETRY_INTERVAL
public static final java.lang.String KEY_RETRY_INTERVAL
A key used to access a RAS object configuration value: the number of milliseconds that a RASHandler will wait before retrying a failed write.

See Also:
Constant Field Values

KEY_SEPARATOR
public static final java.lang.String KEY_SEPARATOR
A key used to access a RAS object configuration value: the string used by the RASFormatter class to separate fields in the formatted output.

See Also:
Constant Field Values

KEY_SERVER
public static final java.lang.String KEY_SERVER
A key used to access a RAS object configuration value: the server name that the RASMessageLogger associates with a logged message.

See Also:
Constant Field Values

KEY_SOCKET_PORT
public static final java.lang.String KEY_SOCKET_PORT
A key used to access a RAS object configuration value: the port used by the RASSocketHandler.

See Also:
Constant Field Values

KEY_SOCKET_SERVER
public static final java.lang.String KEY_SOCKET_SERVER
A key used to access a RAS object configuration value: the name of the server to which the RASSocketHandler will connect.

See Also:
Constant Field Values

KEY_SUPPRESSED_KEYS
public static final java.lang.String KEY_SUPPRESSED_KEYS
A key used to access a RAS object configuration value: the message keys which the RASMessageLogger will not display.

See Also:
Constant Field Values

KEY_THREAD_ID
public static final java.lang.String KEY_THREAD_ID
A key used to access a RAS object configuration value: the thread associated with trace data.

See Also:
Constant Field Values

KEY_TIME_FORMAT
public static final java.lang.String KEY_TIME_FORMAT
A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a time.

See Also:
Constant Field Values

KEY_TRACE_EVENT_CLASSES
public static final java.lang.String KEY_TRACE_EVENT_CLASSES
A key used to access a RAS object configuration value: the set of trace event classes used by a RASLogger.

See Also:
Constant Field Values

KEY_TRACE_MASK
public static final java.lang.String KEY_TRACE_MASK
A key used to access a RAS object configuration value: the trace mask used by a RASTraceLogger and the RASHandler.

See Also:
Constant Field Values

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

Field Summary
static java.lang.String	KEY_CLASS_NAME A key used to access a RAS object configuration value: the name of the class the RASManager must instantiate to create an object.
static java.lang.String	KEY_CLIENT A key used to access a RAS object configuration value: the client name that the RASMessageLogger associates with a logged message.
static java.lang.String	KEY_COMPONENT A key used to access a RAS object configuration value: the component name that the RASMessageLogger associates with a logged message.
static java.lang.String	KEY_DATE_FORMAT A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a date.
static java.lang.String	KEY_DEFAULT_HANDLERS A key used to access a RAS object configuration value: the default handlers that may be attached to any message or trace logger.
static java.lang.String	KEY_DEFAULT_MESSAGE_HANDLERS A key used to access a RAS object configuration value: the default handlers that may be attached to any message logger.
static java.lang.String	KEY_DEFAULT_TRACE_HANDLERS A key used to access a RAS object configuration value: the default handlers that may be attached to any trace logger.
static java.lang.String	KEY_DESCRIPTION A key used to access a RAS object configuration value: the description of any RASObject.
static java.lang.String	KEY_ENCODING A key used to access a RAS object configuration value: the encoding (code page) to be used by the RASFileHandler.
static java.lang.String	KEY_EXCEPTION A key used to access a RAS object configuration value: an Exception in a RAS message.
static java.lang.String	KEY_EXCEPTION_TRACE A key used to access a RAS object configuration value: the stack trace from an Exception in a RAS message.
static java.lang.String	KEY_FILE_NAME A key used to access a RAS object configuration value: the file used by the RASFileHandler.
static java.lang.String	KEY_FORMATTER_NAMES A key used to access a RAS object configuration value: the names of the formatters attached to a RASHandler.
static java.lang.String	KEY_GROUP A key used to access a RAS object configuration value: the RAS group of which a RAS object is a member.
static java.lang.String	KEY_HANDLER_NAMES A key used to access a RAS object configuration value: the names of the handlers attached to a RASLogger.
static java.lang.String	KEY_HEX_DATA A key used to access a RAS object configuration value: an array of bytes to be traced.
static java.lang.String	KEY_IS_CIRCULAR A key used to access a RAS object configuration value: whether a RASHandler is using a circular buffer.
static java.lang.String	KEY_IS_LOGGING A key used to access a RAS object configuration value: the state of a RASLogger (on/off).
static java.lang.String	KEY_IS_SYNC A key used to access a RAS object configuration value: whether a RASLogger is logging synchronously.
static java.lang.String	KEY_LOGGER A key used to access a RAS object configuration value: the name of the RASTraceLogger placed in a trace record.
static java.lang.String	KEY_LOGGING_CLASS A key used to access a RAS object configuration value: the name of the class which logged a RAS event.
static java.lang.String	KEY_LOGGING_METHOD A key used to access a RAS object configuration value: the name of the method which logged a RAS event.
static java.lang.String	KEY_MAX_FILE_SIZE A key used to access a RAS object configuration value: the maximum size, in kilobytes, of each log file used by the RASMultiFileHandler.
static java.lang.String	KEY_MAX_FILES A key used to access a RAS object configuration value: the maximum number of files which a RASMultiFileHandler will use to hold log data.
static java.lang.String	KEY_MAX_QUEUE_SIZE A key used to access a RAS object configuration value: the maximum number of RASIEvents which a RASHandler will hold.
static java.lang.String	KEY_MESSAGE_EVENT_CLASSES A key used to access a RAS object configuration value: the set of message event classes used by a RASLogger.
static java.lang.String	KEY_MESSAGE_FILE A key used to access a RAS object configuration value: a message file name, used by the RASMessageLogger to translate message keys.
static java.lang.String	KEY_MESSAGE_MASK A key used to access a RAS object configuration value: the message mask used by a RASMessageLogger and the RASHandler.
static java.lang.String	KEY_NAME A key used to access a RAS object configuration value: the name of any RASObject.
static java.lang.String	KEY_ORGANIZATION A key used to access a RAS object configuration value: the organization name that the RASMessageLogger associates with a logged message.
static java.lang.String	KEY_PRODUCT A key used to access a RAS object configuration value: the product name that the RASMessageLogger associates with a logged message.
static java.lang.String	KEY_RETRY_INTERVAL A key used to access a RAS object configuration value: the number of milliseconds that a RASHandler will wait before retrying a failed write.
static java.lang.String	KEY_SEPARATOR A key used to access a RAS object configuration value: the string used by the RASFormatter class to separate fields in the formatted output.
static java.lang.String	KEY_SERVER A key used to access a RAS object configuration value: the server name that the RASMessageLogger associates with a logged message.
static java.lang.String	KEY_SOCKET_PORT A key used to access a RAS object configuration value: the port used by the RASSocketHandler.
static java.lang.String	KEY_SOCKET_SERVER A key used to access a RAS object configuration value: the name of the server to which the RASSocketHandler will connect.
static java.lang.String	KEY_SUPPRESSED_KEYS A key used to access a RAS object configuration value: the message keys which the RASMessageLogger will not display.
static java.lang.String	KEY_THREAD_ID A key used to access a RAS object configuration value: the thread associated with trace data.
static java.lang.String	KEY_TIME_FORMAT A key used to access a RAS object configuration value: the SimpleDateFormat format string to be used by the RASFormatter class when formatting a time.
static java.lang.String	KEY_TRACE_EVENT_CLASSES A key used to access a RAS object configuration value: the set of trace event classes used by a RASLogger.
static java.lang.String	KEY_TRACE_MASK A key used to access a RAS object configuration value: the trace mask used by a RASTraceLogger and the RASHandler.
static java.lang.String	RAS_VERSION The current version of the RAS Toolkit.

com.ibm.ras Interface RASConstants

RAS_VERSION

KEY_CLASS_NAME

KEY_CLIENT

KEY_COMPONENT

KEY_DESCRIPTION

KEY_DATE_FORMAT

KEY_DEFAULT_HANDLERS

KEY_DEFAULT_MESSAGE_HANDLERS

KEY_DEFAULT_TRACE_HANDLERS

KEY_ENCODING

KEY_EXCEPTION

KEY_EXCEPTION_TRACE

KEY_FILE_NAME

KEY_FORMATTER_NAMES

KEY_GROUP

KEY_HANDLER_NAMES

KEY_HEX_DATA

KEY_IS_CIRCULAR

KEY_IS_LOGGING

KEY_IS_SYNC

KEY_LOGGER

KEY_LOGGING_CLASS

KEY_LOGGING_METHOD

KEY_MAX_FILES

KEY_MAX_FILE_SIZE

KEY_MAX_QUEUE_SIZE

KEY_MESSAGE_EVENT_CLASSES

KEY_MESSAGE_MASK

KEY_MESSAGE_FILE

KEY_NAME

KEY_ORGANIZATION

KEY_PRODUCT

KEY_RETRY_INTERVAL

KEY_SEPARATOR

KEY_SERVER

KEY_SOCKET_PORT

KEY_SOCKET_SERVER

KEY_SUPPRESSED_KEYS

KEY_THREAD_ID

KEY_TIME_FORMAT

KEY_TRACE_EVENT_CLASSES

KEY_TRACE_MASK

com.ibm.ras
Interface RASConstants