org.dmd.dmp.server.servlet.extended

Class SessionRI

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dmw.DmwHierarchicObjectWrapper

org.dmd.dmp.server.servlet.generated.dmw.SessionRIDMW

org.dmd.dmp.server.servlet.extended.SessionRI

All Implemented Interfaces:

org.dmd.dmc.DmcContainerIF, org.dmd.dmc.DmcHierarchicNamedObjectIF, org.dmd.dmc.DmcNamedObjectIF, org.dmd.dmp.server.DmpPipeIF, DmpEventHandlerIF, DmpResponseHandlerIF, SessionIF

public class SessionRI
extends SessionRIDMW
implements DmpResponseHandlerIF, org.dmd.dmp.server.DmpPipeIF, DmpEventHandlerIF, SessionIF

The SessionRI class represents an authenticated user session. All requests are verified by the security manager to ensure that they have a valid session. Sessions also create the named event channel for the GWT Event Service through which we send DMPEvents and asynchronous responses.

The SessionRI is at the heart of all interactions between the client and the server. Each session has a unique registration with the cache so that all operations performed against the data can be uniquely identified as coming from a particular cache registrant. This allows us to distinguish who did what to the data. On the client, this mechanism can be used to determine whether events coming from the server were caused by you or by some other client.

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Constructor and Description
SessionRI() The empty constructor required for compatibility with the modification recorder mechanisms.
SessionRI(CacheIF c, RequestTrackerIF rt) Instantiates a new session against the specified cache.

Method Summary

Modifier and Type	Method and Description
String	getName()
int	getOriginatorID()
org.dmd.dmp.server.extended.ActionCancelResponse	handleActionCancelRequest(org.dmd.dmp.server.extended.ActionCancelRequest request)
org.dmd.dmp.server.extended.ActionResponse	handleActionRequest(org.dmd.dmp.server.extended.ActionRequest request)
org.dmd.dmp.server.extended.CreateResponse	handleCreateRequest(org.dmd.dmp.server.extended.CreateRequest request)
org.dmd.dmp.server.extended.DeleteResponse	handleDeleteRequest(org.dmd.dmp.server.extended.DeleteRequest request)
void	handleEvent(org.dmd.dmp.server.extended.DMPEvent event) Sends the specified event back to the client.
org.dmd.dmp.server.extended.GetResponse	handleGetRequest(org.dmd.dmp.server.extended.GetRequest request)
void	handleResponse(org.dmd.dmp.server.extended.Request request, org.dmd.dmp.server.extended.Response response) If there have been any operations that have multiple responses e.g.
org.dmd.dmp.server.extended.SetResponse	handleSetRequest(org.dmd.dmp.server.extended.SetRequest request)
void	initializeEventChannel(de.novanic.eventservice.service.RemoteEventServiceServlet s) Initializes the GWT Event Service mechanisms so that the session can handle events and asynchronous responses.
void	sendMessage(org.dmd.dmp.server.extended.DMPMessage msg)
String	sessionID()

Methods inherited from class org.dmd.dmp.server.servlet.generated.dmw.SessionRIDMW

cloneIt, equals, getDMO, getDotName, getHierarchicObjectName, getModificationRecorder, getObjectName, getObjectNameAttribute, getSessionHostRI, getSessionIDRI, getUserRefRI, hashCode, remDotName, remSessionHostRI, remSessionIDRI, remUserRefRI, setDotName, setDotName, setSessionHostRI, setSessionHostRI, setSessionIDRI, setSessionIDRI, setUserRefRI, setUserRefRI

Methods inherited from class org.dmd.dmw.DmwHierarchicObjectWrapper

addSubComponent, getChild, getParentComponent, getParentName, getSubComps, getSubComps, removeSubcomponent, setParentComponent

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionRI

public SessionRI()

The empty constructor required for compatibility with the modification recorder mechanisms. This is never used to create an actual session for use within the DMP reference implementation.

SessionRI

public SessionRI(CacheIF c,
                 RequestTrackerIF rt)

Instantiates a new session against the specified cache.

Parameters:

c - the cache.

Method Detail

initializeEventChannel

public void initializeEventChannel(de.novanic.eventservice.service.RemoteEventServiceServlet s)

Initializes the GWT Event Service mechanisms so that the session can handle events and asynchronous responses.

Parameters:

s - the handle to the servlet derived from RemoteEventServiceServlet.

getOriginatorID

public int getOriginatorID()

Returns:

the unique ID associated with our cache registration.

handleResponse

public void handleResponse(org.dmd.dmp.server.extended.Request request,
                           org.dmd.dmp.server.extended.Response response)

If there have been any operations that have multiple responses e.g. GetRequests with a blocking factor or ActionRequests etc., the first response goes back via the usual mechanisms. Subsequent responses are sent back asynchronously as events. The org.dmd.mvw.client.mvwcomms.extended.CommsController knows how to route these asynchronous responses back to the appropriate component.

Specified by:

handleResponse in interface DmpResponseHandlerIF

Parameters:

request - The original request, which in this case isn't used.

response - The asynchronous response.

handleGetRequest

public org.dmd.dmp.server.extended.GetResponse handleGetRequest(org.dmd.dmp.server.extended.GetRequest request)

handleSetRequest

public org.dmd.dmp.server.extended.SetResponse handleSetRequest(org.dmd.dmp.server.extended.SetRequest request)

handleCreateRequest

public org.dmd.dmp.server.extended.CreateResponse handleCreateRequest(org.dmd.dmp.server.extended.CreateRequest request)

handleDeleteRequest

public org.dmd.dmp.server.extended.DeleteResponse handleDeleteRequest(org.dmd.dmp.server.extended.DeleteRequest request)

handleActionRequest

public org.dmd.dmp.server.extended.ActionResponse handleActionRequest(org.dmd.dmp.server.extended.ActionRequest request)

handleActionCancelRequest

public org.dmd.dmp.server.extended.ActionCancelResponse handleActionCancelRequest(org.dmd.dmp.server.extended.ActionCancelRequest request)

sendMessage

public void sendMessage(org.dmd.dmp.server.extended.DMPMessage msg)

Specified by:

sendMessage in interface org.dmd.dmp.server.DmpPipeIF

getName

public String getName()

Specified by:

getName in interface org.dmd.dmp.server.DmpPipeIF

handleEvent

public void handleEvent(org.dmd.dmp.server.extended.DMPEvent event)

Sends the specified event back to the client.

Specified by:

handleEvent in interface DmpEventHandlerIF

Parameters:

event - The event to be sent.

sessionID

public String sessionID()

Specified by:

sessionID in interface SessionIF

Returns:

a unique identifier for a particular session.