[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class AgentConfig
Public Class AgentConfig
public ref class AgentConfig
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | AgentConfigAgentConfigNew()() | Constructor |
| AddTransportNode(String) | Add a <transport> node for the specified transport protocol. |
| AddZone(String, String, String) | Adds a new zone |
| AddZoneTemplateNode(String) | Add a <template> node for the specified zone template. |
 | AgentPropertyNodes | Gets all <property> values defined for the root
<agent> node.
|
| Apply(Agent, Boolean) | |
| ApplyProperties(Agent, Boolean) | Applies <property> elements to the Agent
|
| ApplyTransports(Agent, Boolean) | Applies <transport> elements to the Agent.
This method selects the <transport> child of the root
<agent> with the enabled attribute set to true.
Only one transport may be enabled; if more than one is enabled the last
definition is considered the agent's default transport protocol. The
<property> elements are then assigned to the agent's
default transport properties for this protocol.
|
| ApplyZones(Agent) | Applies <zone> elements to create new Zone instances.
The caller is responsible for setting up topics, connecting to zones,
and joining zones to topics.
|
| DeleteProperty(String) | Deletes a property. |
| DeleteZone(String) | Deletes a zone |
| DeleteZoneProperty(String, String) | Deletes a zone property. |
| DeleteZoneTemplateProperty(String, String) | Deletes a zone template property. |
| Document | Gets the DOM document |
| GetAgentProperties(AgentProperties) | Populates an AgentProperties object with all <property>
values defined for the root <agent> element.
Properties defined at the root level are applied to the AgentProperties
object of the Agent class. These serve as global defaults to all zones.
Use the getTemplateProperties method to obtain properties for a zone
template, which apply to all zones that reference that template, or the
GetZoneProperties method to obtain properties specific to a zone.
|
| GetProperty(XmlElement, String, String) | Gets the value of a <property> element defined by a node. |
| GetProperty(XmlElement, String, Boolean) |
Gets the bolean value of a <property> element defined by a node. A value of
"True" or "Yes" will return true |
| GetProperty(XmlElement, String, String, String) | A convenience function to get the value of a <property>
defined by the first child element of the specified node that has a
matching tag name. This routine is often used to obtain properties that
are organized into named groups (e.g. <database-settings>,
<transport-settings>, etc.)
For example, to lookup a property named "user" of a top-level
<database-settings> element,
GetProperty( getRootNode(), "database-settings", "user", "sa" ); |
| GetProperty(XmlElement, String, String, Boolean) |
Returns True if the specified property node has text that equals "True" or "Yes", ignoring case
|
| GetPropertyNode(XmlElement, String) | Gets a <property> DOM XmlElement
|
| GetPropertyNodes(XmlElement) | Gets all <property> child nodes of an element |
| GetTransportNode(String) | Gets a <transport> node. |
| GetZoneAttribute(String, String, String) | Gets the value of a <zone> node attribute.
|
| GetZoneNode(String) | Gets the <zone> element with the specified ID |
| GetZoneProperties(IPropertyCollection, String) | Populates a Properties object with all <property>
values defined by a <zone> node as well as all
properties defined by the referenced zone template. Properties defined
by the <zone> override properties defined by the
template.
|
| GetZoneProperties(IPropertyCollection, XmlElement) | Populates a Properties object with all <property>
values defined by a <zone> node as well as all
properties defined by the referenced zone template. Properties defined
by the <zone> override properties defined by the
template.
|
| GetZoneProperty(String, String, String) | Gets the value of a <property> child of the specified
<zone> node.
|
| GetZonePropertyNodes(String) | Gets all <property> values defined for a
<zone> node.
|
| GetZonePropertyNodes(XmlElement) | Gets all <property> values defined for a
<zone> node.
|
| GetZoneTemplateNode(String) | Gets a zone template by ID. |
| GetZoneTemplateProperties(IPropertyCollection, String) | Populates a Properties object with all <property>
values defined for a <template> node.
|
| GetZoneTemplateProperties(IPropertyCollection, XmlElement) | Populates a Properties object with all <property>
values defined for a <template> node.
|
| GetZoneTemplateProperty(String, String, String) | Gets a zone template property. |
| GetZoneTemplatePropertyNode(String, String) | Gets a zone template property node. |
| GetZoneTemplatePropertyNodes(String) | Gets all <property> values defined for a <zone> node. |
| GetZoneTemplatePropertyNodes(XmlElement) | Gets all <property> values defined for a <zone> node. |
| GetZoneTemplates(Boolean) | Gets an array of all zones templates. |
| Loaded | Determines if the configuration file has been loaded |
| Mappings | Gets the Mappings object |
| PopulateProperties(IPropertyCollection, XmlElement) | Populates a Properties object with all <property>
values defined as children of the specified node. Properties that already
exist in the Properties object are not overwritten by properties defined
by the node.
|
| PopulateProperties(IPropertyCollection, XmlElement, Boolean) | Populates a Properties object with all <property>
values defined as children of the specified node. Properties that already
exist in the Properties object are optionally overwritten with properties
defined by the node.
|
| Read(String, Boolean) | Read a configuration file into memory.
|
| RootNode | Gets the root <agent> element |
| Save()() | Saves the XML document back to the file from which it was read. |
| Save(Stream) | Saves the XML document to the specified output stream. |
| Save(StreamWriter) | Saves the XML document to the specified Writer. |
| SetAgentProperty(String, String) | Sets the value of a <property> child of the root
<agent> node. If a <property>
element already exists, its value is updated; otherwise a new element is
appended to the root <agent> node.
|
| SetProperty(XmlElement, String, String) | Sets the value of a <property> child of the specified
node. If a <property> element already exists, its value
is updated; otherwise a new element is appended to the node.
|
| SetProperty(XmlElement, String, String, String) | |
| SetZoneAttribute(String, String, String) | Sets the value of a <zone> node attribute.
|
| SetZoneProperty(String, String, String) | Sets the value of a <property> child of the specified
<zone> node. If a <property> child
already exists with the same name, its value is updated; otherwise a new
element is appended to the <zone> node.
|
| SetZoneTemplateProperty(String, String, String) | Sets the value of a <property> child of the specified
<zone> node. If a <property> child
already exists with the same name, its value is updated; otherwise a new
element is appended to the <template> node.
|
| SourceId | Gets the SourceId that should be used by the agent |
| Version | Gets the version of SIF that should be used by the agent |
| ZoneNodes | Gets an array of all zones defined by the configuration file |
Inheritance Hierarchy| Object | |
 | AgentConfig |