systemic.sif.sifcommon
Class BaseInfo

java.lang.Object
  extended by systemic.sif.sifcommon.BaseInfo
Direct Known Subclasses:
BasePublisher, BaseSubscriber

public class BaseInfo
extends java.lang.Object

This class should be extended by all subscribers and publishers because the Agents expect to have access to that information.

Author:
Joerg Huber

Constructor Summary
BaseInfo()
           
BaseInfo(java.lang.String id)
          Constructor: Assign a unique ID.
 
Method Summary
 openadk.library.tools.cfg.AgentConfig getAgentConfig()
           
 java.lang.String getAgentID()
           
 openadk.library.AgentProperties getAgentProperties()
           
 java.lang.String getAgentProperty(java.lang.String propertyName)
           
 java.lang.String getApplicationID()
           
 openadk.library.ElementDef getDtd()
           
 SIFCommonProperties getFrameworkProperties()
           
 java.lang.String getId()
           
 openadk.library.tools.mapping.Mappings getMappings()
           
 openadk.library.Zone getZoneByID(java.lang.String zoneID)
          This method returns the Zone information for the given zoneID.
 java.util.List<openadk.library.Zone> getZones()
           
 boolean isValidZone(openadk.library.Zone zoneToTest)
           
 void setAgentConfig(openadk.library.tools.cfg.AgentConfig agentConfig)
           
 void setAgentID(java.lang.String agentID)
           
 void setAgentProperties(openadk.library.AgentProperties agentProperties)
           
 void setApplicationID(java.lang.String applicationID)
           
 void setDtd(openadk.library.ElementDef dtd)
           
 void setFrameworkProperties(SIFCommonProperties frameworkProperties)
           
 void setId(java.lang.String id)
           
 void setMappings(openadk.library.tools.mapping.Mappings mappings)
           
 void setZones(java.util.List<openadk.library.Zone> zones)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseInfo

public BaseInfo()

BaseInfo

public BaseInfo(java.lang.String id)
Constructor: Assign a unique ID. Will help for logging and debugging.

Parameters:
id - Unique ID for this object which is either a publisherID or subscriberID.
Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getDtd

public openadk.library.ElementDef getDtd()

setDtd

public void setDtd(openadk.library.ElementDef dtd)

getFrameworkProperties

public SIFCommonProperties getFrameworkProperties()

setFrameworkProperties

public void setFrameworkProperties(SIFCommonProperties frameworkProperties)

getAgentProperties

public openadk.library.AgentProperties getAgentProperties()

getAgentID

public java.lang.String getAgentID()

setAgentID

public void setAgentID(java.lang.String agentID)

setAgentProperties

public void setAgentProperties(openadk.library.AgentProperties agentProperties)

getZones

public java.util.List<openadk.library.Zone> getZones()

setZones

public void setZones(java.util.List<openadk.library.Zone> zones)

getAgentConfig

public openadk.library.tools.cfg.AgentConfig getAgentConfig()

setAgentConfig

public void setAgentConfig(openadk.library.tools.cfg.AgentConfig agentConfig)

getMappings

public openadk.library.tools.mapping.Mappings getMappings()

setMappings

public void setMappings(openadk.library.tools.mapping.Mappings mappings)

getApplicationID

public java.lang.String getApplicationID()

setApplicationID

public void setApplicationID(java.lang.String applicationID)

getAgentProperty

public java.lang.String getAgentProperty(java.lang.String propertyName)

isValidZone

public boolean isValidZone(openadk.library.Zone zoneToTest)

getZoneByID

public openadk.library.Zone getZoneByID(java.lang.String zoneID)
This method returns the Zone information for the given zoneID. If no zone is know for the given zoneID then null is returned.

Parameters:
zoneID - The id of the zone for which the Zone information shall be returned.
Returns:
See Description