systemic.sif.sbpframework.subscriber
Class SyncSubscriber

java.lang.Object
  extended by systemic.sif.sifcommon.BaseInfo
      extended by systemic.sif.sifcommon.subscriber.BaseSubscriber
          extended by systemic.sif.sbpframework.subscriber.SyncSubscriber
All Implemented Interfaces:
java.lang.Runnable, openadk.library.QueryResults, openadk.library.Subscriber
Direct Known Subclasses:
SBPBaseSubscriber, SBPNoDOCSubscriber

public abstract class SyncSubscriber
extends systemic.sif.sifcommon.subscriber.BaseSubscriber

This Class implements the Sync Control Functionality through some tables rather than through the default behaviour of the SIFCommon Framework. This is simply done by overwriting the default sync(Zone zone) method from the BaseSubscriber class in the SIFCommon Framework.

It is important to note that if the SIFCommon Framework property file turns off sync altogether then the method in this class has no affect, meaning it will be ignored. This allows a developer to control the sync from outside this bit of code and if there is a need that the agent should never call a sync then the agent._agentid_.sync.frequency property in the SIFAgent.properties should be set to 0. Please refer to the Developer's Guide of the SIFCommon Framework.

Author:
Joerg Huber

Constructor Summary
SyncSubscriber(java.lang.String subscriberID, openadk.library.ElementDef dtd)
           
 
Method Summary
 void sync(openadk.library.Zone zone)
           
 
Methods inherited from class systemic.sif.sifcommon.subscriber.BaseSubscriber
debugOnEvent, debugOnQueryResults, finalise, getQueryResultsOptions, getSubscriptionOptions, onEvent, onQueryPending, onQueryResults, processEvent, processResponse, provision, reportSIFError, run, setQueryResultsOptions, setSubscriptionOptions, shutdownSubscriber, startConsumers
 
Methods inherited from class systemic.sif.sifcommon.BaseInfo
getAgentConfig, getAgentID, getAgentProperties, getAgentProperty, getApplicationID, getDtd, getFrameworkProperties, getId, getMappings, getZoneByID, getZones, isValidZone, setAgentConfig, setAgentID, setAgentProperties, setApplicationID, setDtd, setFrameworkProperties, setId, setMappings, setZones
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SyncSubscriber

public SyncSubscriber(java.lang.String subscriberID,
                      openadk.library.ElementDef dtd)
Method Detail

sync

public void sync(openadk.library.Zone zone)
          throws openadk.library.ADKException
Overrides:
sync in class systemic.sif.sifcommon.subscriber.BaseSubscriber
Throws:
openadk.library.ADKException