Glacier2

Class SessionHelper

java.lang.Object

Glacier2.SessionHelper

public class SessionHelper
extends java.lang.Object

A helper class for using Glacier2 with GUI applications.

Constructor Summary

Constructors

Constructor and Description
SessionHelper(SessionCallback callback, Ice.InitializationData initData, java.lang.String finderStr, boolean useCallbacks) Creates a Glacier2 session.

Method Summary

Modifier and Type	Method and Description
Ice.ObjectPrx	addWithUUID(Ice.Object servant) Adds a servant to the callback object adapter's Active Servant Map with a UUID.
java.lang.String	categoryForClient() Returns the category to be used in the identities of all of the client's callback objects.
Ice.Communicator	communicator() Returns the session's communicator object.
protected void	connect(java.util.Map<java.lang.String,java.lang.String> context) Connects to the Glacier2 router using the associated SSL credentials.
protected void	connect(java.lang.String username, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> context) Connects a Glacier2 session using user name and password credentials.
void	destroy() Destroys the Glacier2 session.
boolean	isConnected() Returns true if there is an active session, otherwise returns false.
Ice.ObjectAdapter	objectAdapter() Creates an object adapter for callback objects.
SessionPrx	session() Returns the Glacier2 session proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionHelper

public SessionHelper(SessionCallback callback,
                     Ice.InitializationData initData,
                     java.lang.String finderStr,
                     boolean useCallbacks)

Creates a Glacier2 session.

Parameters:

callback - The callback for notifications about session establishment.

initData - The InitializationData for initializing the communicator.

finderStr - The stringified Ice.RouterFinder proxy.

useCallbacks - True if the session should create an object adapter for receiving callbacks.

Method Detail

destroy

public void destroy()

Destroys the Glacier2 session. Once the session has been destroyed, SessionCallback.disconnected(Glacier2.SessionHelper) is called on the associated callback object.

communicator

public Ice.Communicator communicator()

Returns the session's communicator object.

Returns:

The communicator.

categoryForClient

public java.lang.String categoryForClient()
                                   throws SessionNotExistException

Returns the category to be used in the identities of all of the client's callback objects. Clients must use this category for the router to forward callback requests to the intended client.

Returns:

The category.

Throws:

SessionNotExistException - No session exists.

addWithUUID

public Ice.ObjectPrx addWithUUID(Ice.Object servant)
                          throws SessionNotExistException

Adds a servant to the callback object adapter's Active Servant Map with a UUID.

Parameters:

servant - The servant to add.

Returns:

The proxy for the servant.

Throws:

SessionNotExistException - No session exists.

session

public SessionPrx session()
                   throws SessionNotExistException

Returns the Glacier2 session proxy. If the session hasn't been established yet, or the session has already been destroyed, throws SessionNotExistException.

Returns:

The session proxy, or throws SessionNotExistException if no session exists.

Throws:

SessionNotExistException - No session exists.

isConnected

public boolean isConnected()

Returns true if there is an active session, otherwise returns false.

Returns:

trueif session exists or false if no session exists.

objectAdapter

public Ice.ObjectAdapter objectAdapter()
                                throws SessionNotExistException

Creates an object adapter for callback objects.

Returns:

The object adapter.

Throws:

SessionNotExistException - No session exists.

connect

protected void connect(java.util.Map<java.lang.String,java.lang.String> context)

Connects to the Glacier2 router using the associated SSL credentials. Once the connection is established, SessionCallback.connected(Glacier2.SessionHelper) is called on the callback object; upon failure, SessionCallback.connectFailed(Glacier2.SessionHelper, java.lang.Throwable) is called with the exception.

Parameters:

context - The request context to use when creating the session.

connect

protected void connect(java.lang.String username,
                       java.lang.String password,
                       java.util.Map<java.lang.String,java.lang.String> context)

Connects a Glacier2 session using user name and password credentials. Once the connection is established, SessionCallback.connected(Glacier2.SessionHelper) is called on the callback object; upon failure SessionCallback.connectFailed(Glacier2.SessionHelper, java.lang.Throwable) is called with the exception.

Parameters:

username - The user name.

password - The password.

context - The request context to use when creating the session.