ecologylab.services.messages
Class RequestMessage

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.ServiceMessage
              ecologylab.services.messages.RequestMessage

All Implemented Interfaces:

OptimizationTypes, XMLTranslationExceptionTypes, java.lang.Comparable<ServiceMessage>

Direct Known Subclasses:

CfCollaborationGetSurrogate, CfCollaborationGetSurrogate, CloseMessage, HttpRequest, IgnoreRequest, InitConnectionRequest, KmlRequest, Login, Logout, LogRequestMessage, SeedCf, SetPreferences, StopMessage, UrlMessage

public abstract class RequestMessage
extends ServiceMessage

Abstract base class for ecologylab.services DCF request messages.

Author:

blake, andruid

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

Fields inherited from class ecologylab.services.messages.ServiceMessage

sender, timeStamp, uid

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

RequestMessage()

Method Summary

boolean	isDisposable() Indicates whether or not this type of message may be ignored by the server, if the server becomes backed-up.
ResponseMessage	performService(Scope objectRegistry) Deprecated. Use performService(Scope,String) instead
abstract ResponseMessage	performService(Scope objectRegistry, java.lang.String sessionId) Perform the service associated with the request, using the supplied context as needed.

Methods inherited from class ecologylab.services.messages.ServiceMessage

compareTo, getSender, getTimeStamp, getUid, setSender, setUid, stampTime

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestMessage

public RequestMessage()

Method Detail

performService

public ResponseMessage performService(Scope objectRegistry)

Deprecated. Use performService(Scope,String) instead

Perform the service associated with the request, using the supplied context as needed. Calls performService(objectRegistry, null);

Parameters:

objectRegistry - Context to perform it in/with.

Returns:

Response to pass back to the (remote) caller.

performService

public abstract ResponseMessage performService(Scope objectRegistry,
                                               java.lang.String sessionId)

Perform the service associated with the request, using the supplied context as needed.

Parameters:

objectRegistry - Context to perform it in/with.

sessionId - TODO

Returns:

Response to pass back to the (remote) caller.

isDisposable

public boolean isDisposable()

Indicates whether or not this type of message may be ignored by the server, if the server becomes backed-up. For example, a RequestMessage subclass that simply requests the server's current state may be ignored if a more recent copy of one has arrived later. By default, RequestMessages are not disposable; this method should be overriden if they are to be.

Returns:

false.