raccoon.api.eai.message
Interface IBusMessage

All Superinterfaces:
java.io.Externalizable, IMessage, java.io.Serializable
All Known Implementing Classes:
RvMessage

public interface IBusMessage
extends IMessage, java.io.Externalizable

The interface for accessing an EAI message that can be sent over the Bus (MOM).

Since:
Raccoon v0.7
Version:
$Id: IBusMessage.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $
Author:
Cedric ROUVRAIS

Method Summary
 void appendMsgTracking(java.lang.String pTrackingInfo)
          Adds to the tracking information of this message.
 java.lang.String getMsgReply()
          Retrieve the subject on which the reply to this message must be sent.
 java.lang.String getMsgSend()
          Retrieve the subject on which this messaging element was sent on.
 ITracking getMsgTracking()
          Retrieves from this message the related tracking information.
 IMessage getPayload()
          Retrieves the payload associated to this message.
 boolean isReservedKeyword(java.lang.String pFieldName)
          Checks if the given field name is a reserved keyword.
 void setMsgReply(java.lang.String pReplySubject)
          Defines the subject on which the reply to this message must be sent.
 void setMsgSend(java.lang.String pSubject)
          Defines the subject on which this message is to be sent on.
 void setMsgTracking(ITracking pTracking)
          Defines the tracking information that this message must bear.
 
Methods inherited from interface raccoon.api.eai.message.IMessage
addMsgField, append, append, append, append, append, append, getMsgField, getMsgField, getMsgFieldAt, getMsgFields, getMsgSize, getName, getNativeMsg, getSequence, hashMsgFields, nbMsgFields, removeMsgField, removeMsgField, removeMsgFieldAt, setMsgFields, setName, updateField
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 

Method Detail

getMsgSend

java.lang.String getMsgSend()
Retrieve the subject on which this messaging element was sent on.

Returns:
the subject that is compliant with the message layer

setMsgSend

void setMsgSend(java.lang.String pSubject)
                throws java.lang.IllegalArgumentException
Defines the subject on which this message is to be sent on.

Parameters:
pSubject - the string subject that is compliant with the message layer
Throws:
java.lang.IllegalArgumentException - if the subject is invalid

getMsgReply

java.lang.String getMsgReply()
Retrieve the subject on which the reply to this message must be sent.

Returns:
the subject that is compliant with the message layer, null if no reply is expected.

setMsgReply

void setMsgReply(java.lang.String pReplySubject)
                 throws java.lang.IllegalArgumentException
Defines the subject on which the reply to this message must be sent.

Parameters:
pReplySubject - the subject that is compliant with the message layer
Throws:
java.lang.IllegalArgumentException - if the subject is invalid

getMsgTracking

ITracking getMsgTracking()
Retrieves from this message the related tracking information.

Returns:
the tracking information assigned to this message

setMsgTracking

void setMsgTracking(ITracking pTracking)
Defines the tracking information that this message must bear.

Parameters:
pTracking - the tracking information for this message

appendMsgTracking

void appendMsgTracking(java.lang.String pTrackingInfo)
Adds to the tracking information of this message.

Parameters:
pTrackingInfo - the additional tracking information to add.

getPayload

IMessage getPayload()
Retrieves the payload associated to this message.

Returns:
the payload without specific middleware information.

isReservedKeyword

boolean isReservedKeyword(java.lang.String pFieldName)
Checks if the given field name is a reserved keyword. Reserved keywords are field names used by the middleware layer and shouldn't be normally used by the program.

Parameters:
pFieldName - the name of the field to test.
Returns:
true if the field name is a reserved word.


Copyright null null. All Rights Reserved.