com.novell.zos.grid
Interface Message.LoginSuccess

All Superinterfaces:

Cloneable, Message, Message.ConnectionID, Serializable

Enclosing interface:

Message

public static interface Message.LoginSuccess
extends Message, Message.ConnectionID

Response message for a successful login.

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.GetSecret, Message.GetSecretResponse, 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

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, GET_SECRET, GET_SECRET_RESPONSE, 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

AuthenticationInfo	getAuthenticationInfo() Get the user info from the Authentication Manager.
String	getGridName() Retrieve grid server name logged into.
Credential	getSessionCredential() Return the session credentials for this login.
void	setAuthenticationInfo(AuthenticationInfo info) Set the user info from the Authentication Manager.

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

getCreationTime, getSource, getType, getTypeString

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

getConnectionID, setConnectionID

Method Detail

getGridName

String getGridName()

Retrieve grid server name logged into.

Returns:

Grid Server name

getAuthenticationInfo

AuthenticationInfo getAuthenticationInfo()

Get the user info from the Authentication Manager.

Returns the AuthenticationInfo instance set on the request by the Authentication Manager upon successful authentication.

Returns:

Authenticated user info.

setAuthenticationInfo

void setAuthenticationInfo(AuthenticationInfo info)

Set the user info from the Authentication Manager.

Sets the AuthenticationInfo instance set on the request by the Authentication Manager upon successful authentication.

Parameters:

info - Authenticated user info.

getSessionCredential

Credential getSessionCredential()

Return the session credentials for this login.

A successful login results in session credentials that may be used to connect for messaging. It is best if the login exchange happens over a secure channel, such as a socket using TLS encryption.

Returns:

The new session's authentication credentials.