com.novell.zos.grid
Interface Message.SessionStatus

All Superinterfaces:

Cloneable, Message, Serializable

Enclosing interface:

Message

public static interface Message.SessionStatus
extends Message

Nested Class Summary

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

Message.Ack, Message.AuthFailure, Message.ClientResponseMessage, 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.NeedUpgrade, Message.RunningJobs, Message.ServerStatus, Message.SessionAck, Message.SessionChallenge, Message.SessionResponse, Message.SessionStatus

Field Summary

static int	SESSION_ALREADY_IN_USE
static int	SESSION_AUTH_FAILED
static int	SESSION_AUTH_SUCCEEDED
static int	SESSION_EXPIRED
static int	SESSION_LOGGED_OUT
static int	SESSION_REVOKED
static int	SESSION_SHUTDOWN
static int	SESSION_SUB_ILLEGAL
static int	SESSION_SUB_REFUSED
static int	SESSION_SUB_TOO_MANY
static int	SESSION_TIMED_OUT

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

ACK, AUTH_FAILURE, 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_RESPONSE, SESSION_STATUS

Method Summary

byte[]	getCResponse() Return the server's hashed response to the CNonce.
int	getDGClientId() Return the last seen Data Grid "session id".
SessionInfoFull	getSessionConfig() Return the session configuration to use for this new sesison.
long	getSessionId() Return the ID of the session being authenticated.
int	getSessionStatus() Return the session status code for this authentication.

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

getCreationTime, getSource, getType, getTypeString

Field Detail

SESSION_AUTH_SUCCEEDED

static final int SESSION_AUTH_SUCCEEDED

See Also:

Constant Field Values

SESSION_AUTH_FAILED

static final int SESSION_AUTH_FAILED

See Also:

Constant Field Values

SESSION_LOGGED_OUT

static final int SESSION_LOGGED_OUT

See Also:

Constant Field Values

SESSION_TIMED_OUT

static final int SESSION_TIMED_OUT

See Also:

Constant Field Values

SESSION_EXPIRED

static final int SESSION_EXPIRED

See Also:

Constant Field Values

SESSION_REVOKED

static final int SESSION_REVOKED

See Also:

Constant Field Values

SESSION_SHUTDOWN

static final int SESSION_SHUTDOWN

See Also:

Constant Field Values

SESSION_ALREADY_IN_USE

static final int SESSION_ALREADY_IN_USE

See Also:

Constant Field Values

SESSION_SUB_ILLEGAL

static final int SESSION_SUB_ILLEGAL

See Also:

Constant Field Values

SESSION_SUB_TOO_MANY

static final int SESSION_SUB_TOO_MANY

See Also:

Constant Field Values

SESSION_SUB_REFUSED

static final int SESSION_SUB_REFUSED

See Also:

Constant Field Values

Method Detail

getSessionId

long getSessionId()

Return the ID of the session being authenticated.

In all cases, this ID will be the correct session ID of the session connected to. If a new subsession was requested, then this method returns the new subsession ID and not the parent session ID.

The parent session ID is available in the SessionInfoFull instance returned by Message.SessionStatus.getSessionConfig().

Returns:

The unique ID of the session currently connected to.

getSessionStatus

int getSessionStatus()

Return the session status code for this authentication.

Lets the client know if the session authentication was successful, or if it failed due to inactivity timeout, bad authentication, etc.

Returns:

The status of this authentication exchange.

getSessionConfig

SessionInfoFull getSessionConfig()

Return the session configuration to use for this new sesison.

Once the session connection is established, the client must make sure that it's session ACK window parameters match those of the server to prevent deadlocks.

Returns:

The session configuration parameters to use on the client.

getCResponse

byte[] getCResponse()

Return the server's hashed response to the CNonce.

Returns the server's response to the CNonce field in the SessionResponse message. This can be checked by the client to ensure that the server is legitimate.

Returns:

The server-generated response field.

getDGClientId

int getDGClientId()

Return the last seen Data Grid "session id".

This is really a "client id" used to uniquely identify inbound queues on the client side. With full session support we need to make sure new session connections don't reuse old client IDs too quickly.

Returns:

The last seen Data Grid client instance ID.