net.sf.xbus.protocol.bytearraylist
Class ByteArrayListMessage

java.lang.Object
  net.sf.xbus.protocol.Message
      net.sf.xbus.protocol.xml.XMLMessageAbstract
          net.sf.xbus.protocol.bytearraylist.ByteArrayListMessage

All Implemented Interfaces:

ObjectMessage, TextMessage, XMLMessage

public class ByteArrayListMessage
extends XMLMessageAbstract
implements ObjectMessage

ByteArrayListMessage

Constructor Summary

ByteArrayListMessage(java.lang.String function, XBUSSystem source, java.lang.String id)
Constructor for ByteArrayListMessage.

ByteArrayListMessage(XBUSSystem source)
Constructor for ByteArrayListMessage.

Method Summary

java.lang.Object	getRequestObject(XBUSSystem system) Gets the object from an incomimg message.
java.lang.Object	getResponseObject() Gets the object of the outgoing message.
void	setEncodingSystem(XBUSSystem system)
void	setRequestObject(java.lang.Object obj, XBUSSystem source) Parses the incoming ByteArrayListinto a XML document.
void	setResponseObject(java.lang.Object obj, XBUSSystem destination) Empty method
protected void	synchronizeRequestFields(XBUSSystem system) After setting the request data, both setRequestText and setRequestDocument, some fields of the Message must be synchronized with the request data.
protected void	synchronizeResponseFields(XBUSSystem system) After setting the response data, both setResponseText and setResponseDocument, some fields of the Message must be synchronized with the response data.

Methods inherited from class net.sf.xbus.protocol.xml.XMLMessageAbstract

getDocumentBuilder, getRequestDocument, getRequestText, getResponseDocument, getResponseText, parseXML, serializeXML, setRequestDocument, setRequestText, setResponseDocument, setResponseText

Methods inherited from class net.sf.xbus.protocol.Message

getErrorcode, getErrortext, getFunction, getId, getRequestTimestamp, getResponseTimestamp, getReturncode, getShortname, getSource, setErrorcode, setErrortext, setFunction, setId, setResponseTimestamp, setReturncode, setShortname

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayListMessage

public ByteArrayListMessage(XBUSSystem source)

Constructor for ByteArrayListMessage.

Parameters:

source -

ByteArrayListMessage

public ByteArrayListMessage(java.lang.String function,
                            XBUSSystem source,
                            java.lang.String id)

Constructor for ByteArrayListMessage.

Parameters:

function -

source -

id -

Method Detail

setRequestObject

public void setRequestObject(java.lang.Object obj,
                             XBUSSystem source)
                      throws XException

Parses the incoming ByteArrayListinto a XML document.

Specified by:

setRequestObject in interface ObjectMessage

Overrides:

setRequestObject in class XMLMessageAbstract

Parameters:

obj - the content of the request

source - system where the request is coming from

Throws:

XException

See Also:

ObjectMessage.setRequestObject(java.lang.Object, net.sf.xbus.base.xbussystem.XBUSSystem)

setResponseObject

public void setResponseObject(java.lang.Object obj,
                              XBUSSystem destination)

Empty method

Specified by:

setResponseObject in interface ObjectMessage

Overrides:

setResponseObject in class XMLMessageAbstract

Parameters:

obj - the content of the response

destination - system where the response is coming from

See Also:

ObjectMessage.setResponseObject(java.lang.Object, net.sf.xbus.base.xbussystem.XBUSSystem)

getRequestObject

public java.lang.Object getRequestObject(XBUSSystem system)
                                  throws XException

Description copied from interface: ObjectMessage

Gets the object from an incomimg message.

Specified by:

getRequestObject in interface ObjectMessage

Overrides:

getRequestObject in class XMLMessageAbstract

Parameters:

system - reference to the system for which the message is meant

Returns:

ByteArrayList

Throws:

XException

See Also:

ObjectMessage.getRequestObject(net.sf.xbus.base.xbussystem.XBUSSystem)

getResponseObject

public java.lang.Object getResponseObject()

Description copied from interface: ObjectMessage

Gets the object of the outgoing message.

Specified by:

getResponseObject in interface ObjectMessage

Overrides:

getResponseObject in class XMLMessageAbstract

Returns:

always null

See Also:

ObjectMessage.getResponseObject()

setEncodingSystem

public void setEncodingSystem(XBUSSystem system)

synchronizeRequestFields

protected void synchronizeRequestFields(XBUSSystem system)

Description copied from class: XMLMessageAbstract

After setting the request data, both setRequestText and setRequestDocument, some fields of the Message must be synchronized with the request data.

• Id: When the Id is found in the request data, it must be copied to the Message. When it is not found, the value from the Message must be copied to the request data.
• Function: The value for the function must be read from the request data and must be set in the Message.
• Source: Must be copied from the Message object to the request data, to be sure that it is set correct.
• Request Timestamp: Must be copied from the Message object to the request data.

Specified by:

synchronizeRequestFields in class XMLMessageAbstract

synchronizeResponseFields

protected void synchronizeResponseFields(XBUSSystem system)

Description copied from class: XMLMessageAbstract

After setting the response data, both setResponseText and setResponseDocument, some fields of the Message must be synchronized with the response data.

• Returncode: The value of the returncode must be extracted out of the response data.
• Errorcode: When an error has occured, the value for the errorcode can be read out of the response data, if it is included there.
• Errortext: When an error has occured, the value for the errortext can be read out of the response data, if it is included there.

Specified by:

synchronizeResponseFields in class XMLMessageAbstract