org.safs.sockets

Class Message

java.lang.Object

org.safs.sockets.Message

Direct Known Subclasses:

JavaSocketsUtils, Message, MessageUtil

public class Message
extends java.lang.Object

The SocketProtocol Messages used between the SAFS Messaging Service.

Author:

Carl Nagle, SAS Institute, Inc.

See Also:

SocketProtocol

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ISREMOTERESULT "isremoteresult" Property key for the validation property with String value "true" or "false".
static java.lang.String	KEY_REMOTERESULTCODE "remoteresultcode" Property key for the String value of the int statuscode.
static java.lang.String	KEY_REMOTERESULTINFO "remoteresultinfo" Property key for the String value of additional statusinfo, if any.
static java.lang.String	msg_connected "connected"
static java.lang.String	msg_debug "debug"
static java.lang.String	msg_dispatchfile "dispatchfile"
static java.lang.String	msg_dispatchprops "dispatchprops"
static java.lang.String	msg_exception "exception"
static java.lang.String	msg_message "message"
static java.lang.String	msg_ready "ready"
static java.lang.String	msg_remoteshutdown "remoteshutdown" -- a normal shutdown.
static java.lang.String	msg_result "result"
static java.lang.String	msg_resultprops "resultprops"
static java.lang.String	msg_running "running"
static java.lang.String	msg_sep ":"
static java.lang.String	msg_shutdown "shutdown" -- usually reporting an unexpected shutdown.
static java.lang.String	NULL_VALUE "<_NULL_>" A non-null value representing a real null value.
static int	shutdown_cause_controller
static int	shutdown_cause_device
static int	shutdown_cause_normal
static int	shutdown_cause_service
static int	STATUS_REMOTE_NOT_EXECUTED
static java.lang.String	STATUS_REMOTE_NOT_EXECUTED_STRING
static int	STATUS_REMOTERESULT_FAIL
static java.lang.String	STATUS_REMOTERESULT_FAIL_STRING
static int	STATUS_REMOTERESULT_OK
static java.lang.String	STATUS_REMOTERESULT_OK_STRING
static int	STATUS_REMOTERESULT_UNKNOWN
static java.lang.String	STATUS_REMOTERESULT_UNKNOWN_STRING
static int	STATUS_REMOTERESULT_WARN
static java.lang.String	STATUS_REMOTERESULT_WARN_STRING

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getStackTrace(java.lang.Throwable x) Create a String from a Throwable suitable for debug output that provides comparable information to x.printStackTrace();

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_REMOTERESULT_UNKNOWN

public static final int STATUS_REMOTERESULT_UNKNOWN

See Also:

Constant Field Values

STATUS_REMOTERESULT_WARN

public static final int STATUS_REMOTERESULT_WARN

See Also:

Constant Field Values

STATUS_REMOTE_NOT_EXECUTED

public static final int STATUS_REMOTE_NOT_EXECUTED

See Also:

Constant Field Values

STATUS_REMOTERESULT_FAIL

public static final int STATUS_REMOTERESULT_FAIL

See Also:

Constant Field Values

STATUS_REMOTERESULT_OK

public static final int STATUS_REMOTERESULT_OK

See Also:

Constant Field Values

STATUS_REMOTERESULT_UNKNOWN_STRING

public static final java.lang.String STATUS_REMOTERESULT_UNKNOWN_STRING

STATUS_REMOTE_NOT_EXECUTED_STRING

public static final java.lang.String STATUS_REMOTE_NOT_EXECUTED_STRING

STATUS_REMOTERESULT_FAIL_STRING

public static final java.lang.String STATUS_REMOTERESULT_FAIL_STRING

STATUS_REMOTERESULT_WARN_STRING

public static final java.lang.String STATUS_REMOTERESULT_WARN_STRING

STATUS_REMOTERESULT_OK_STRING

public static final java.lang.String STATUS_REMOTERESULT_OK_STRING

msg_sep

public static java.lang.String msg_sep

":"

msg_debug

public static final java.lang.String msg_debug

"debug"

See Also:

Constant Field Values

msg_exception

public static final java.lang.String msg_exception

"exception"

See Also:

Constant Field Values

msg_connected

public static final java.lang.String msg_connected

"connected"

See Also:

Constant Field Values

msg_ready

public static final java.lang.String msg_ready

"ready"

See Also:

Constant Field Values

msg_dispatchprops

public static final java.lang.String msg_dispatchprops

"dispatchprops"

See Also:

Constant Field Values

msg_dispatchfile

public static final java.lang.String msg_dispatchfile

"dispatchfile"

See Also:

Constant Field Values

msg_message

public static final java.lang.String msg_message

"message"

See Also:

Constant Field Values

msg_running

public static final java.lang.String msg_running

"running"

See Also:

Constant Field Values

msg_result

public static final java.lang.String msg_result

"result"

See Also:

Constant Field Values

msg_resultprops

public static final java.lang.String msg_resultprops

"resultprops"

See Also:

Constant Field Values

msg_remoteshutdown

public static final java.lang.String msg_remoteshutdown

"remoteshutdown" -- a normal shutdown.

See Also:

Constant Field Values

msg_shutdown

public static final java.lang.String msg_shutdown

"shutdown" -- usually reporting an unexpected shutdown.

See Also:

Constant Field Values

shutdown_cause_normal

public static final int shutdown_cause_normal

See Also:

Constant Field Values

shutdown_cause_service

public static final int shutdown_cause_service

See Also:

Constant Field Values

shutdown_cause_device

public static final int shutdown_cause_device

See Also:

Constant Field Values

shutdown_cause_controller

public static final int shutdown_cause_controller

See Also:

Constant Field Values

KEY_ISREMOTERESULT

public static final java.lang.String KEY_ISREMOTERESULT

"isremoteresult" Property key for the validation property with String value "true" or "false". "true" indicates the results information in the Properties instance should be considered valid results issued from the remote client.

See Also:

Constant Field Values

KEY_REMOTERESULTCODE

public static final java.lang.String KEY_REMOTERESULTCODE

"remoteresultcode" Property key for the String value of the int statuscode.

See Also:

Constant Field Values

KEY_REMOTERESULTINFO

public static final java.lang.String KEY_REMOTERESULTINFO

"remoteresultinfo" Property key for the String value of additional statusinfo, if any.

See Also:

Constant Field Values

NULL_VALUE

public static final java.lang.String NULL_VALUE

"<_NULL_>" A non-null value representing a real null value.

See Also:

Constant Field Values

Constructor Detail

Message

public Message()

Method Detail

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable x)

Create a String from a Throwable suitable for debug output that provides comparable information to x.printStackTrace();

Parameters:

x -

Returns:

String ready for output to debug(String) or other sink.