ecologylab.services.messages
Class ServiceMessage

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RequestMessage, ResponseMessage

public class ServiceMessage
extends ElementState
implements java.lang.Comparable<ServiceMessage>

Abstract base class for ecologylab.services DCF request and response messages.

Author:

blake

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

protected java.net.InetAddress	sender Contains the IP address of the host that sent this message.
protected long	timeStamp
protected long	uid Deprecated.

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

ServiceMessage()

Method Summary

int	compareTo(ServiceMessage otherRequest) Deprecated.
java.net.InetAddress	getSender()
long	getTimeStamp()
long	getUid() Deprecated.
void	setSender(java.net.InetAddress sender) This method should be called by a server when it translates this message.
void	setUid(long uid) Deprecated.
void	stampTime() Sets timeStamp to equal the current system time in milliseconds.

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

Field Detail

timeStamp

protected long timeStamp

uid

@Deprecated
protected long uid

Deprecated.

Used to carry uid for messages, now only used by legacy code. Retained temporarily for backwards compatability.

sender

protected java.net.InetAddress sender

Contains the IP address of the host that sent this message. sender currently must be set by a server that recieves the message and associates it with the IP address from it's packet and/or channel.

Constructor Detail

ServiceMessage

public ServiceMessage()

Method Detail

stampTime

public void stampTime()

Sets timeStamp to equal the current system time in milliseconds.

getTimeStamp

public long getTimeStamp()

Returns:

Returns the timeStamp in milliseconds.

setUid

@Deprecated
public void setUid(long uid)

Deprecated.

getUid

@Deprecated
public long getUid()

Deprecated.

getSender

public java.net.InetAddress getSender()

Returns:

the sender's IP address

setSender

public void setSender(java.net.InetAddress sender)

This method should be called by a server when it translates this message.

Parameters:

sender - the sender's IP address to set

compareTo

@Deprecated
public int compareTo(ServiceMessage otherRequest)

Deprecated.

Specified by:

compareTo in interface java.lang.Comparable<ServiceMessage>