com.novell.zos.grid
Interface Message.ServerStatus

All Superinterfaces:

Cloneable, Message, Serializable

Enclosing interface:

Message

public static interface Message.ServerStatus
extends Message

A ServerStatus message.

ServerStatus is different from a normal status message from the server because it normally requires an action on the part of the receiver whereas a Status is more informational. ServerStatus can be used for server shutdown, restart, version upgrade, migration to new host, etc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.novell.zos.grid.Message

Message.Ack, Message.AuthFailure, Message.ClientResponseMessage, Message.ConnectionID, Message.Event, Message.GetGridObjects, Message.GridObjects, Message.JobAccepted, Message.JobError, Message.JobFinished, Message.JobIdEvent, Message.JobInfo, Message.Jobs, Message.JobStarted, Message.JobStatus, Message.LoginFailed, Message.LoginSuccess, Message.LogoutAck, Message.RunningJobs, Message.ServerStatus

Field Summary

static int	LOGOUT
static int	NO_STATUS
static int	SHUTDOWN

Fields inherited from interface com.novell.zos.grid.Message

ACK, AUTH_FAILURE, CLIENT_OFFLINE, CLIENT_OFFLINE_ACK, CLIENT_ONLINE, CLIENT_ONLINE_ACK, COMPLETE, EVENT, GET_GRID_OBJECTS, GRID_OBJECTS, JOB_ACCEPTED, JOB_ERROR, JOB_FINISHED, JOB_INFO, JOB_STARTED, JOB_STATUS, JOB_STATUS_DETAIL, JOBS, LOGIN_FAILED, LOGIN_SUCCESS, LOGOUT_ACK, NEED_UPGRADE, RUN_JOB2, RUNNING_JOBS, SERVER_STATUS, SESSION_ACK, SESSION_CHALLENGE, SESSION_INIT, SESSION_RESPONSE, SESSION_STATUS, SESSION_TERM

Method Summary

Throwable	getCause() Return the exception that caused a LOGOUT.
String	getMessage() Retrieve status message from server.
int	getStatusType() Returns one of the integer constants indicating what kind of server status is being reported.

Methods inherited from interface com.novell.zos.grid.Message

getCreationTime, getSource, getType, getTypeString

Field Detail

NO_STATUS

static final int NO_STATUS

See Also:

Constant Field Values

SHUTDOWN

static final int SHUTDOWN

See Also:

Constant Field Values

LOGOUT

static final int LOGOUT

See Also:

Constant Field Values

Method Detail

getStatusType

int getStatusType()

Returns one of the integer constants indicating what kind of server status is being reported.

getMessage

String getMessage()

Retrieve status message from server.

Returns:

Status message from server. maybe null.

getCause

Throwable getCause()

Return the exception that caused a LOGOUT.

Returns the exception that caused a LOGOUT indication to be generated, if such logout was due to an error.

Returns:

The exception that caused a LOGOUT.