systemic.sif.sifcommon.model
Class SubscriberMessage

java.lang.Object
  extended by systemic.sif.sifcommon.model.BaseMessage
      extended by systemic.sif.sifcommon.model.SubscriberMessage
All Implemented Interfaces:
java.io.Serializable

public class SubscriberMessage
extends BaseMessage
implements java.io.Serializable

This class encapsulates a SIF message that has been received by a subscriber, might this be an event or a response. It holds all required information relating to a SIF Message that is given by the ZIS to the subscriber.

The main intent of this class is the ability to package all the parameters of the onEvent() or the onRequest() method in one object that can then be passed around to processes, threads, persistence etc.

Author:
Joerg Huber
See Also:
Serialized Form

Constructor Summary
SubscriberMessage()
          Will create a default subscriber message with a auto-generated messageID.
SubscriberMessage(openadk.library.SIFDataObject sifObject, openadk.library.Zone zone, MappingInfo mappingInfo)
          Constructor if this object should represent a SIF Response.
SubscriberMessage(openadk.library.SIFDataObject sifObject, openadk.library.Zone zone, MappingInfo mappingInfo, openadk.library.EventAction eventAction)
          Constructor if this object should represent a SIF Event.
 
Method Summary
 openadk.library.EventAction getEventAction()
           
 MappingInfo getMappingInfo()
           
 openadk.library.SIFDataObject getSIFObject()
           
 openadk.library.Zone getZone()
           
 boolean isEvent()
           
 void setEvent(boolean isEvent)
           
 void setEventAction(openadk.library.EventAction eventAction)
           
 void setMappingInfo(MappingInfo mappingInfo)
           
 void setSIFObject(openadk.library.SIFDataObject sifObject)
           
 void setZone(openadk.library.Zone zone)
           
 
Methods inherited from class systemic.sif.sifcommon.model.BaseMessage
getCreationDate, getMessageGUID, getNumRetries, setCreationDate, setMessageGUID, setNumRetries
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubscriberMessage

public SubscriberMessage()
Will create a default subscriber message with a auto-generated messageID.


SubscriberMessage

public SubscriberMessage(openadk.library.SIFDataObject sifObject,
                         openadk.library.Zone zone,
                         MappingInfo mappingInfo,
                         openadk.library.EventAction eventAction)
Constructor if this object should represent a SIF Event. A auto-generated messageID will be assigned.

Parameters:
sifObject - The SIF Object for this Subscriber Message (Should not be null).
zone - The zone for this Subscriber Message.
mappingInfo - The mapping info for this Subscriber Message.
eventAction - The event action for this Subscriber Message (Should not be null).

SubscriberMessage

public SubscriberMessage(openadk.library.SIFDataObject sifObject,
                         openadk.library.Zone zone,
                         MappingInfo mappingInfo)
Constructor if this object should represent a SIF Response. A auto-generated messageID will be assigned.

Parameters:
sifObject - The SIF Object for this Subscriber Message (Should not be null).
zone - The zone for this Subscriber Message.
mappingInfo - The mapping info for this Subscriber Message.
Method Detail

isEvent

public boolean isEvent()

setEvent

public void setEvent(boolean isEvent)

getSIFObject

public openadk.library.SIFDataObject getSIFObject()

setSIFObject

public void setSIFObject(openadk.library.SIFDataObject sifObject)

getZone

public openadk.library.Zone getZone()

setZone

public void setZone(openadk.library.Zone zone)

getEventAction

public openadk.library.EventAction getEventAction()

setEventAction

public void setEventAction(openadk.library.EventAction eventAction)

getMappingInfo

public MappingInfo getMappingInfo()

setMappingInfo

public void setMappingInfo(MappingInfo mappingInfo)