org.dmd.dmp.server.extended

Class Request

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmp.server.generated.dmw.DMPMessageDMW

org.dmd.dmp.server.extended.DMPMessage

org.dmd.dmp.server.generated.dmw.RequestDMW

org.dmd.dmp.server.extended.Request

All Implemented Interfaces:

DmcContainerIF

Direct Known Subclasses:

ActionCancelRequestDMW, ActionRequestDMW, ClientCountFilterRequestDMW, CreateRequestDMW, DeleteRequestDMW, DenotifyRequestDMW, GetRequestDMW, LoginRequestDMW, LogoutRequestDMW, NotifyRequestDMW, PreAuthRequestDMW, SetRequestDMW

public abstract class Request
extends RequestDMW

The Request class is the base of all request messages. At this level we add some additional hooks to provide access to session and user objects that are generally useful when handling requests within the server.

Field Summary

Fields inherited from class org.dmd.dmp.server.extended.DMPMessage

request

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request()
protected	Request(RequestDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
protected void	fillError(Response response) A convenience function to fill standard values in newly created response.
protected void	fillStandard(Response response) A convenience function to fill standard values in newly created response.
abstract Response	getErrorResponse() Derived classes must overload this method to return a new response of the appropriate type.
Object	getUInfo()
Object	getUserInfo()
void	setSessionInfo(Object s)
void	setUserInfo(Object s)

Methods inherited from class org.dmd.dmp.server.generated.dmw.RequestDMW

getDMO, getHandlerID, getModificationRecorder, getOriginatorID, getResponseFormat, getSessionID, getTimeoutSeconds, getUserName, isNotifyOriginator, isReadableFormat, remHandlerID, remNotifyOriginator, remOriginatorID, remReadableFormat, remResponseFormat, remSessionID, remTimeoutSeconds, remUserName, setHandlerID, setHandlerID, setNotifyOriginator, setNotifyOriginator, setOriginatorID, setOriginatorID, setReadableFormat, setReadableFormat, setResponseFormat, setResponseFormat, setSessionID, setSessionID, setTimeoutSeconds, setTimeoutSeconds, setUserName, setUserName

Methods inherited from class org.dmd.dmp.server.extended.DMPMessage

getLastRequestID, getServletRequest, removeLastRequestID

Methods inherited from class org.dmd.dmp.server.generated.dmw.DMPMessageDMW

addNvp, addNvp, addRequestID, addRequestID, delNvp, delNvp, delRequestID, delRequestID, getNvpCopy, getNvpHasValue, getNvpIsEmpty, getNvpIterable, getNvpSize, getRequestIDCopy, getRequestIDHasValue, getRequestIDIsEmpty, getRequestIDIterable, getRequestIDSize, getTimeMS, isTrackingEnabled, nvpContains, remNvp, remRequestID, remTimeMS, remTrackingEnabled, requestIDContains, setTimeMS, setTimeMS, setTrackingEnabled, setTrackingEnabled

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toJSON, 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, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Request

protected Request()

Request

protected Request(RequestDMO obj,
                  ClassDefinition cd)

Method Detail

fillStandard

protected void fillStandard(Response response)

A convenience function to fill standard values in newly created response.

Parameters:

response - The response subclass.

Throws:

DmcValueException

fillError

protected void fillError(Response response)

A convenience function to fill standard values in newly created response.

Parameters:

response - The response subclass.

Throws:

DmcValueException

getErrorResponse

public abstract Response getErrorResponse()

Derived classes must overload this method to return a new response of the appropriate type. This is a convenience method for creating basic error responses so that we don't have to concern ourselves with the exact type of request - we just want to fill in some error information and fire it back.

Returns:

A response with its response type set to ERROR.

Throws:

DmcValueException

setSessionInfo

public void setSessionInfo(Object s)

getUInfo

public Object getUInfo()

setUserInfo

public void setUserInfo(Object s)

getUserInfo

public Object getUserInfo()