[This is preliminary documentation and is subject to change.]
A global class representing the SIFWorks® Adk class framework.
Prior to calling any Adk methods or referencing any static constants, agents
must first initialize the Adk by calling the static Adk.initialize
method. The default initialize method loads all SIF Data Object
(Sdo) modules and selects the latest version of SIF as the default version
used to render SIF Messages. If you use this method, ensure that the proper
assemblies are available on the path. Other forms of the initialize
method allow you to choose the specific Sdo modules that are loaded as well
as the version of SIF that will be the default for this agent session.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public sealed class Adk
Public NotInheritable Class Adk
public ref class Adk sealed
Members| All Members | Methods | Properties | Fields | ||
| Icon | Member | Description |
|---|---|---|
  | AdkVersion | Gets the Adk build version |
| Debug | The Adk debugging level determines which types of messages will be
submitted to the logging environment by the class framework. |
 | DEFAULT_LOG_PATTERN |
The default pattern used for writing to the logging framework
|
| Dtd |
The Dtd that the ADK is currently using to parse and write SIF Objects
|
 | GetLatestSupportedVersion(array<SifVersion>[]()) |
Returns the highes SIFVersion supported by the current instance of the ADK
from the list of candidate versions. This method is helpful to agents
during SIF_Request processing. A SIF_Request can contain multiple versions
and the responding agent may want to choose the lastest supported version
from the list.
|
| Initialize()() | Initialize the Adk to use the latest version of SIF and all SIF Data
Object (Sdo) libraries.
Calling this method when the Adk has already been initialized has no effect.
|
| Initialize(SifVersion, SdoLibraryType) | Initialize the Adk to use the specified version of SIF.
Calling this method when the Adk has already been initialized has no effect.
This method must be called at agent startup to initialize
various resources of the Adk, establish global settings for the
class framework, and set the default version of SIF to which
all messages originating from the agent will conform.
Beginning with Adk 1.5.0, this method also configures the global
Adk ServerLog instance with a logging module that
will be inherited by the ServerLog of all zones. It installs a
single logging module implementation: DefaultServerLogModule.
The behavior of this module is to report SIF_LogEntry objects to
the zone integration server via an Add SIF_Event message whenever
ServerLog.reportLogEntry is called on a zone and
the agent is running in SIF 1.5 or later. DefaultServerLogModule
also echos server log messages to the zone's local logging framework Category
so that agents do not need to duplicate logging to both the server
and local agent log. If you want to install a custom ServerLogModule
implementation -- or need to adjust the settings of the default
module installed when the Adk is initialized -- call the
Adk.getServerLog method to obtain a reference to the
root of the ServerLog chain, then call its methods
to add and remove modules. Refer to the ServerLog class for more
information on server logging.
|
| Initialized |
Has the Adk Been Initialized
|
| InstallTransport(TransportPlugin) |
Installs a new TransportProtocol
|
| IsSIFVersionSupported(SifVersion) | Determines if the specified version of SIF is supported by the Adk |
| Log | Returns the root logging framework Category for the Adk.
Agents that wish to customize Adk logging may call this method to
obtain the root logging framework Category.
|
| LOG_IDENTIFIER |
The Identifier that is used to identify the ADK itself for logging operations ("ADK")
|
| MakeGuid()() |
Utility method to generate a GUID for SIF Data Objects and messages.
|
| ServerLog | Gets the root ServerLog instance for the Adk. |
| SetLogFile(String) | Redirects all log output to the specified file. |
| SifVersion | Gets the version of SIF used by the agent |
| SupportedSIFVersions | Gets the versions of SIF supported by the Adk |
| TextFormatter |
The SIFFormatter used by default for backwards-compatible non-typed
APIs in the ADK, such as TextValue. The default
formatter used by the ADK is the SIF 1.x formatter for backwards compatibility.
If you are using the strongly-typed APIs, such as TextValue,
this setting has no effect.
|
| TransportProtocols | Gets the transport protocols available to agents. |
Inheritance Hierarchy| Object | |
 | Adk |