org.safs

Class JavaSocketsUtils

java.lang.Object

org.safs.sockets.Message

org.safs.JavaSocketsUtils

Direct Known Subclasses:

MessageUtil

public class JavaSocketsUtils
extends Message

Constants and utilities used by a JavaSocketsHook and a remote SocketProtocol client.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_LOGCOMMENT "logcomment" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGCOMMENT_FAILED "logcomment_failed" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGCOMMENT_GENERIC "logcomment_generic" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGCOMMENT_PARAMS "logcomment_params" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGDETAIL "logdetail" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGDETAIL_FAILED "logdetail_failed" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGDETAIL_GENERIC "logdetail_generic" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGDETAIL_PARAMS "logdetail_params" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	KEY_LOGTYPE "logtype" -- Property name key for Properties returned in resultsProps messages.
static java.lang.String	LOGTYPE_FAILED_MESSAGE "1024" FAILED log message.
static java.lang.String	LOGTYPE_FAILED_OK_MESSAGE "1025" FAILED_OK log message.
static java.lang.String	LOGTYPE_GENERIC_MESSAGE "0" GENERIC log message.
static java.lang.String	LOGTYPE_PASSED_MESSAGE "2048" PASSED/OK log message.
static java.lang.String	LOGTYPE_WARNING_MESSAGE "4096" WARNING log message.
static java.lang.String	LOGTYPE_WARNING_OK_MESSAGE "4097" WARNING OK log message.

Fields inherited from class org.safs.sockets.Message

KEY_ISREMOTERESULT, KEY_REMOTERESULTCODE, KEY_REMOTERESULTINFO, msg_connected, msg_debug, msg_dispatchfile, msg_dispatchprops, msg_exception, msg_message, msg_ready, msg_remoteshutdown, msg_result, msg_resultprops, msg_running, msg_sep, msg_shutdown, NULL_VALUE, shutdown_cause_controller, shutdown_cause_device, shutdown_cause_normal, shutdown_cause_service, STATUS_REMOTE_NOT_EXECUTED, STATUS_REMOTE_NOT_EXECUTED_STRING, STATUS_REMOTERESULT_FAIL, STATUS_REMOTERESULT_FAIL_STRING, STATUS_REMOTERESULT_OK, STATUS_REMOTERESULT_OK_STRING, STATUS_REMOTERESULT_UNKNOWN, STATUS_REMOTERESULT_UNKNOWN_STRING, STATUS_REMOTERESULT_WARN, STATUS_REMOTERESULT_WARN_STRING

Constructor Summary

Constructors

Constructor and Description
JavaSocketsUtils()

Method Summary

Methods inherited from class org.safs.sockets.Message

getStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

KEY_LOGTYPE

public static final java.lang.String KEY_LOGTYPE

"logtype" -- Property name key for Properties returned in resultsProps messages. This property holds a String representation for the "type" of message to log.

Valid logtypes are found in AbstractLogFacility. The most common of these are already encoded below in the LOGTYPE_ fields.

See Also:

Constant Field Values

LOGTYPE_FAILED_MESSAGE

public static final java.lang.String LOGTYPE_FAILED_MESSAGE

"1024" FAILED log message.

See Also:

Constant Field Values

LOGTYPE_FAILED_OK_MESSAGE

public static final java.lang.String LOGTYPE_FAILED_OK_MESSAGE

"1025" FAILED_OK log message.

See Also:

Constant Field Values

LOGTYPE_GENERIC_MESSAGE

public static final java.lang.String LOGTYPE_GENERIC_MESSAGE

"0" GENERIC log message.

See Also:

Constant Field Values

LOGTYPE_PASSED_MESSAGE

public static final java.lang.String LOGTYPE_PASSED_MESSAGE

"2048" PASSED/OK log message.

See Also:

Constant Field Values

LOGTYPE_WARNING_MESSAGE

public static final java.lang.String LOGTYPE_WARNING_MESSAGE

"4096" WARNING log message.

See Also:

Constant Field Values

LOGTYPE_WARNING_OK_MESSAGE

public static final java.lang.String LOGTYPE_WARNING_OK_MESSAGE

"4097" WARNING OK log message.

See Also:

Constant Field Values

KEY_LOGCOMMENT

public static final java.lang.String KEY_LOGCOMMENT

"logcomment" -- Property name key for Properties returned in resultsProps messages. This property holds the log comment to be used "as-is". The comment is NOT the name of a string resource stored in SAFS GENERIC or FAILED resource bundles.

See Also:

Constant Field Values

KEY_LOGDETAIL

public static final java.lang.String KEY_LOGDETAIL

"logdetail" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds the log detail to be used "as-is". The detail is NOT the name of a string resource stored in SAFS GENERIC or FAILED resource bundles.

See Also:

Constant Field Values

KEY_LOGCOMMENT_GENERIC

public static final java.lang.String KEY_LOGCOMMENT_GENERIC

"logcomment_generic" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds the name of the key to use when converting a String resource message in the Generic Strings Resource Bundle for a log comment.

See Also:

GENStrings.convert(String, String, java.util.Collection), Constant Field Values

KEY_LOGCOMMENT_FAILED

public static final java.lang.String KEY_LOGCOMMENT_FAILED

"logcomment_failed" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds the name of the key to use when converting a String resource message in the Failed Strings Resource Bundle for a log comment.

See Also:

FAILStrings.convert(String, String, java.util.Collection), Constant Field Values

KEY_LOGCOMMENT_PARAMS

public static final java.lang.String KEY_LOGCOMMENT_PARAMS

"logcomment_params" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds comma-delimited parameter values used when converting a String resource message from either the Generic Strings bundle or the Failed Strings bundle.

See Also:

GENStrings.convert(String, String, java.util.Collection), FAILStrings.convert(String, String, java.util.Collection), Constant Field Values

KEY_LOGDETAIL_GENERIC

public static final java.lang.String KEY_LOGDETAIL_GENERIC

"logdetail_generic" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds the name of the key to use when converting a String resource message in the Generic Strings Resource Bundle for a log detail.

See Also:

GENStrings.convert(String, String, java.util.Collection), Constant Field Values

KEY_LOGDETAIL_FAILED

public static final java.lang.String KEY_LOGDETAIL_FAILED

"logdetail_failed" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds the name of the key to use when converting a String resource message in the Failed Strings Resource Bundle for a log detail.

See Also:

FAILStrings.convert(String, String, java.util.Collection), Constant Field Values

KEY_LOGDETAIL_PARAMS

public static final java.lang.String KEY_LOGDETAIL_PARAMS

"logdetail_params" -- Property name key for Properties returned in resultsProps messages. This property, if present, holds comma-delimited parameter values used when converting a String resource message from either the Generic Strings bundle or the Failed Strings bundle for a log detail.

See Also:

GENStrings.convert(String, String, java.util.Collection), FAILStrings.convert(String, String, java.util.Collection), Constant Field Values

Constructor Detail

JavaSocketsUtils

public JavaSocketsUtils()