This section documents the messaging and message handling protocols defined in SIF. A messaging protocol consists of sending a SIF_Message
to initiate an operation, receiving back a SIF_Ack; a message handling protocol consists of processing an incoming SIF_Message
and responding with a SIF_Ack and possibly sending follow-up SIF_Messages. This section is independent
of transport layer details, aside from encryption and authentication level impacts associated with individual messages.
Unless otherwise noted, all protocols assume successful communication over the appropriate transport layer;
agent and ZIS implementations should also be prepared to handle transport layer errors and exceptions, directly or wrapped in
a SIF_Ack/SIF_Error by underlying code.
This section documents how Agents should send individual messages, and the resulting post-conditions upon success or failure, along with any necessary steps to take. These correspond to each of the operations an Agent can initiate.
An Agent must register with the ZIS to participate in a Zone. To do so, it sends a SIF_Register
message. An Agent may at any time re-register by sending another SIF_Register message.
The ZIS updates the Agent's registered settings accordingly.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Register message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place your Agent's name, supported versions and maximum buffer size for receiving messages
into SIF_Name, SIF_Version and SIF_MaxBufferSize, respectively.
Specify whether your Agent is Push- or Pull-mode in SIF_Mode. If SIF_Mode is Push,
specify the protocol information for the ZIS to use when delivering messages to your agent in SIF_Protocol.
If desired, supply optional information regarding your Agent and/or application in SIF_NodeVendor,
SIF_NodeVersion, SIF_Application and SIF_Icon.
|
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now registered in the Zone. The Access Control settings for your agent (SIF_AgentACL are in
SIF_Status/SIF_Data). |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. Note particularly category 5. |
Messaging protocol complete (failure). |
An Agent removes itself from a Zone by sending a SIF_Unregister message to the ZIS. Successful
completion of this operation removes all settings associated with the Agent, including the objects it is currently
providing and subscribed to in the zone; the Agent's message queue is also deleted. Note that a successful
SIF_Unregister message may, depending on the ZIS implementation, remove access control settings that
have been manually configured by a Zone administrator and that may need to be re-configured for a subsequent
successful SIF_Register.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Unregister message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now removed from the Zone. | Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
An Agent registers with the ZIS to be the default Responder, or Provider, for one or more
SIF objects in one or more contexts by sending a SIF_Provide
message to the ZIS. The Agent must have access control rights at the ZIS to successfully register
as a Provider for an object.
Note that upon successful completion of SIF_Provide that your Agent is still the Provider
of any objects for which it was previously registered as the Provider. To unregister as the Provider
of given objects, use SIF_Unprovide. To replace all objects your Agent provides in one
operation, use SIF_Provision.
As of version 2.0 of this specification, SIF_Provision is the preferred method for registering an
Agent as a Provider, and provisioning an Agent in general. Support for SIF_Provide may be removed
in a future major release of this specification.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Provide message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. For each object your Agent would like to provide, place a SIF_Object element with an
ObjectName and optionally one or more SIF_Context names (which default to SIF_Default if omitted).
Your Agent's support for SIF_ExtendedQuery can be specified in SIF_ExtendedQuerySupport for each object.
|
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now the Provider of each of the objects specified in the SIF_Provide message, in the
applicable context(s). Any request sent by an Agent for one of these objects without explicitly specifying
a particular Responder in SIF_Header/SIF_DestinationId will be placed in your Agent's message queue. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. Note particularly category 4, code 3 (no permission to provide)
and category 6, code 4 (object already has a Provider). |
Messaging protocol complete (failure). |
Your Agent unregisters with the ZIS as the default Responder, or Provider, for one or more
SIF objects in one or more contexts by sending a SIF_Unprovide
message to the ZIS. Note that any
SIF_Requests for these objects already pending in your Agent's queue will still be delivered.
As of version 2.0 of this specification, SIF_Provision is the preferred method for unregistering an
Agent as a Provider, and provisioning an Agent in general. Support for SIF_Unprovide may be removed
in a future major release of this specification.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Unprovide message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. For each object your Agent would like to provide, include a SIF_Object element with an
ObjectName and optionally one or more SIF_Context names (which default to SIF_Default if omitted). |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is no longer the Provider of each of the objects specified in the SIF_Unprovide message, in the
applicable context(s). SIF_Requests will no longer be routed to your Agent by default, but this
does not prevent other Agents from sending requests directly to your Agent (if permitted by access control rights). |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
An Agent registers with the ZIS to receive SIF_Events for one or more SIF objects
in one or more contexts by sending a SIF_Subscribe
message to the ZIS. The Agent must have access control rights at the ZIS to successfully subscribe
to events for an object.
Note that upon successful completion of SIF_Subscribe that your Agent is still subscribed to objects
to which it had previously subscribed. To unregister as a Subscriber
of given objects, use SIF_Unsubscribe. To replace all objects to which your Agent subscribes in one
operation, use SIF_Provision.
As of version 2.0 of this specification, SIF_Provision is the preferred method for registering an
Agent as a Subscriber, and provisioning an Agent in general. Support for SIF_Subscribe may be removed
in a future major release of this specification.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Subscribe message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. For each object your Agent would like to subscribe to, place a SIF_Object element with an
ObjectName and optionally one or more SIF_Context names (which default to SIF_Default if omitted). |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now subscribed to each of the objects specified in the SIF_Subscribe message, in the
specified context(s) if included. Any SIF_Events for these objects will be placed in your Agent's queue. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. Note particularly category 4, code 4 (no permission to subscribe). |
Messaging protocol complete (failure). |
To stop receiving SIF_Events for one or more objects in one or more contexts, an Agent sends a
SIF_Unsubscribe
message to the ZIS. Note that if there are events already pending in your Agent's queue for these objects,
they will still be delivered after a successful SIF_Unsubscribe.
As of version 2.0 of this specification, SIF_Provision is the preferred method for unregistering an
Agent as a Subscriber, and provisioning an Agent in general. Support for SIF_Unsubscribe may be removed
in a future major release of this specification.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_Unsubscribe message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. For each object your Agent would like to cease receiving events, include a SIF_Object element with an
ObjectName and optionally one or more SIF_Context names (which default to SIF_Default if omitted). |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now unsubscribed from each of the objects specified in the SIF_Unsubscribe message, in the
applicable context(s). SIF_Events for these objects will cease to be placed in your Agent's queue. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
The SIF_Provision message provides an Agent the ability to register the objects it provides and to
which it subscribes in a single operation, replacing whatever settings the ZIS has on record for the Agent. In effect
it is an alternative to SIF_Provide, SIF_Unprovide, SIF_Subscribe and SIF_Unsubscribe,
though an Agent may choose to use this message or those, or a combination of these messages.
This message also
allows the Agent to fully describe the operations it will perform in a Zone beyond those that can be
communicated with SIF_Provide
and SIF_Subscribe, including the types of events it will publish, the requests to which it will respond with or without
being the Provider for requested objects, and the objects for which it sends requests.
The Agent must have the appropriate access control settings to successfully register any of the corresponding information included
in SIF_Provision. Note that the list of access control settings can be determined by examining the SIF_AgentACL
object returned in the SIF_Register or SIF_GetAgentACL message protocols.
Note that SIF_Provision will also fail if the Agent is attempting to provide an object that is already provided
by another Agent in the applicable Zone Context. The list of Providers in a Zone can be found in SIF_ZoneStatus.
As of version 2.0 of this specification, SIF_Provision is the preferred method for provisioning an Agent.
Support for SIF_Subscribe, SIF_Unsubscribe, SIF_Provide and SIF_Unprovide
may be removed in a future major release of this specification.
| Step | Process | Flow Control |
| 1 |
Prepare a Include Include Include Include Include |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent is now registered with the corresponding settings in the Zone. Any previously recorded settings with regard to the operations your Agent performs have been replaced. | Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
When an application adds, changes or deletes data represented in one or more Zone Contexts, its Agent SHOULD
publish the corresponding Add, Change or Delete SIF_Event to the Zone. Upon
successful delivery of a SIF_Event to the ZIS, the ZIS places the event in the queue for any
Agents subscribed to events for the object, including your Agent if it is a subscriber.
| Step | Process | Flow Control |
| 1 |
Prepare a Specify the name of the object that is being added, changed or deleted in
For a
For a |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | The event has been successfully received by the ZIS. It will be placed in the queue of any Agents registered as subscribers to events for the given object. | Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
An Agent can request data from another Agent at any time by sending a SIF_Request message. Agents use one of two
query mechanisms in requests. SIF's
default query mechanism, SIF_Query, is used to request objects of a given type, matching optional query conditions, optionally
returning a subset of object elements. SIF_ExtendedQuery is used to select elements from
one or more objects, joined together, if necessary, on RefId-based conditions. Before delivering a request with a
SIF_ExtendedQuery to a Responder, the ZIS checks that the Responder supports SIF_ExtendedQuery
for all referenced objects.
| Step | Process | Flow Control |
| 1 |
Prepare a |
If using |
| 2 | In SIF_Query, specify the object name being requested in SIF_QueryObject/@ObjectName.
Optionally specify the subset of elements/attributes to be returned from each object in
SIF_QueryObject/SIF_Element; note that parent elements of specified elements/attributes are returned as well.
If your Agent would like to specify query matching conditions, include SIF_ConditionGroup. Alternately an example of an object allowed for use in query-by-example can be placed in
SIF_Example.
|
Send SIF_Message to ZIS over appropriate transport. Go to step 4. |
| 3 | Include a SIF_ExtendedQuery. If your Agent did not specify
SIF_DestinationId, the SIF_Request will be routed to the Provider for SIF_From/@ObjectName.
If your Agent would like to override this routing mechanism, include SIF_DestinationProvider set
to the object name for which the ZIS will determine the Provider and route the request accordingly. |
Send SIF_Message to ZIS over appropriate transport. |
| 4 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 5 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 7. |
| 6 | The request has been successfully received by the ZIS. It will be placed in the queue of the appropriate Responder
as specified in SIF_Header/SIF_DestinationId or determined by SIF_ExtendedQuery/SIF_From/@ObjectName
or SIF_ExtendedQuery/SIF_DestinationProvider. |
Messaging protocol complete (success). |
| 7 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 8 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
An agent can "ping" the ZIS or check that it's online and/or "awake" by sending
a SIF_Ping message to the ZIS. If the agent receives
a successful acknowledgement, the ZIS is awake; the ZIS may also reply that it is asleep. As
a ZIS may be offline completely, Agents should be prepared to handle transport errors directly
or wrapped in a SIF_Ack/SIF_Error by underlying code.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Ping
element in SIF_SystemControlData.
|
Send SIF_Message to ZIS over appropriate transport.
|
| 2 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 8. |
| 3 |
Is SIF_Status/SIF_Code 0?
|
If no, go to Step 5. |
| 4 | The ZIS is awake. | Messaging protocol complete (success). |
| 5 |
Is SIF_Status/SIF_Code 8 (ZIS is asleep)?
|
If no, go to Step 7. |
| 6 | The ZIS is asleep. | Messaging protocol complete (success). |
| 7 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
7 (your Agent sent a duplicate SIF_MsgId).
|
Messaging protocol complete (failure). |
| 8 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included.
|
Messaging protocol complete (failure). |
A Push-mode Agent can send
a SIF_Sleep message to the ZIS to change its state
to "asleep," indicating that the ZIS should not send the Agent messages until it "wakes up"
by sending a SIF_Wakeup message or re-registering with SIF_Register.
A Pull-mode Agent can also changes it state to "sleeping," but this has no effect other than indicating
to other Agents via SIF_ZoneStatus that it is "sleeping" and not processing messages in its queue.
Sending a SIF_Wakeup or SIF_GetMessage will indicate that the Agent is "awake,"
as will re-registering with SIF_Register.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Sleep
element in SIF_SystemControlData. |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent's state has been set to "asleep" in the ZIS. This is reflected to other Agents
in SIF_ZoneStatus and if your Agent is a Push-mode Agent, the ZIS will stop
delivering messages to your Agent. To "wake up," send a SIF_Wakeup message, or re-register
with SIF_Register. Pull-mode Agents may also send SIF_GetMessage. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
An Agent can send
a SIF_Wakeup message to the ZIS to change its state to "awake," whether sleeping
or not; this state is available to other Agents via SIF_ZoneStatus.
Upon success, the ZIS may begin delivering messages to a Push-mode Agent again, if previously sleeping.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Wakeup
element in SIF_SystemControlData. |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 | Your Agent's state has been set to "awake" in the ZIS. This is reflected to other Agents
in SIF_ZoneStatus and if your Agent is a Push-mode Agent and it was previously
asleep, the ZIS will resume delivering messages to your Agent. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
To retrieve the current status of the Zone (SIF_ZoneStatus),
send a SIF_GetZoneStatus message to the ZIS.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_GetZoneStatus
element in SIF_SystemControlData. |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 |
SIF_Status/SIF_Data contains the current status of the Zone in SIF_ZoneStatus. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
To retrieve your Agent's current access control list settings from the ZIS (SIF_AgentACL), send a SIF_GetAgentACL message to the ZIS.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_GetAgentACL
element in SIF_SystemControlData. |
Send SIF_Message to ZIS over appropriate transport. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 6. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 |
SIF_Status/SIF_Data contains your Agent's current access control list settings in the Zone in
SIF_AgentACL. |
Messaging protocol complete (success). |
| 5 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 6 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
Pull-mode Agents retrieve the next message in their queue by sending
a SIF_GetMessage message to the ZIS. Note that as individual messages
may have specific minimum encryption/authentication levels attached to them by senders, a Pull-Mode Agent should always
use the highest encryption/authentication levels it supports when contacting the ZIS to avoid individual messages
being discarded when contacting the ZIS using lower encryption/authentication levels than might be required for receipt
of a given message.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_GetZoneStatus
element in SIF_SystemControlData. |
Send SIF_Message to ZIS over appropriate transport. Always use the highest encryption/authentication levels
that your Agent supports to maximize the number of messages that can be returned to your Agent. |
| 2 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 7. |
| 3 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 5. |
| 4 |
SIF_Status/SIF_Data contains the next SIF_Message in your agent's queue. |
Messaging protocol complete (success). Process the returned SIF_Message
according to Agent Message Handling Protocols below. |
| 5 | Is SIF_Status/SIF_Code 9? |
If yes, there are no messages available for your Agent. Message processing complete (success). |
| 6 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 7 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. If a Push-mode Agent sends SIF_GetMessage, note particularly category 5,
code 9 (agent registered in Push mode). |
Messaging protocol complete (failure). |
Push-Mode Agents end Selective Message Blocking (SMB) by sending a final SIF_Ack to the ZIS.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Message/SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. From the message being unblocked/removed from the queue, place the SIF_Header/SIF_SourceId
value into SIF_OriginalSourceId and place the SIF_Header/SIF_MsgId value into SIF_OriginalMsgId.
Place 3 (final SIF_Ack) into SIF_Code/SIF_Data.
|
Send SIF_Message to ZIS over appropriate transport.
|
| 2 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 6. |
| 3 |
Is SIF_Status/SIF_Code 0?
|
If no, go to Step 5. |
| 4 | The referenced message has been unblocked and removed from your Agent's queue. The ZIS resumes delivery of events to your Agent. | Messaging protocol complete (success). |
| 5 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId).
|
Messaging protocol complete (failure). |
| 6 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included.
|
Messaging protocol complete (failure). |
Pull-mode Agents acknowledge messages received in response to SIF_GetMessage and remove them from their queue by sending a SIF_Ack
message to the ZIS. SIF_Ack is also sent by Pull-Mode Agents to invoke and end Selective Message Blocking (SMB).
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Message/SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. |
If your Agent is invoking SMB, go to Step 3. If your Agent is ending SMB, go to Step 4. |
| 2 |
From the message being acknowledged/the message to be removed from the queue, place the SIF_Header/SIF_SourceId
value into SIF_OriginalSourceId and place the SIF_Header/SIF_MsgId value into SIF_OriginalMsgId.
Place 1 (immediate SIF_Ack) into SIF_Code/SIF_Data or an appropriate error description in
SIF_Error. If your Agent indicates a transport error or places 8 (receiver is sleeping) into
SIF_Code/SIF_Data, the message
will be acknowledged but remain in your Agent's queue.
|
Send SIF_Message to ZIS over appropriate transport. Go to Step 5.
|
| 3 |
From the SIF_Event being blocked, place the SIF_Header/SIF_SourceId
value into SIF_OriginalSourceId and place the SIF_Header/SIF_MsgId value into SIF_OriginalMsgId.
Place 2 (intermediate SIF_Ack) into SIF_Code/SIF_Data.
|
Send SIF_Message to ZIS over appropriate transport. Go to Step 5.
|
| 4 |
From the SIF_Event being unblocked, place the SIF_Header/SIF_SourceId
value into SIF_OriginalSourceId and place the SIF_Header/SIF_MsgId value into SIF_OriginalMsgId.
Place 3 (final SIF_Ack) into SIF_Code/SIF_Data.
|
Send SIF_Message to ZIS over appropriate transport.
|
| 5 | Receive SIF_Ack in response.
Is SIF_Error present? |
If yes, go to Step 9. |
| 6 | Is SIF_Status/SIF_Code 0? |
If no, go to Step 8. |
| 7 |
If your Agent did not invoke or end SMB for a
If your Agent invoked SMB by sending an intermediate
If your Agent ended SMB by sending a final |
Messaging protocol complete (success). |
| 8 | Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (ZIS is asleep) or 7 (your Agent sent a duplicate SIF_MsgId). |
Messaging protocol complete (failure). |
| 9 | Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. |
Messaging protocol complete (failure). |
This section documents how Agents should respond to incoming messages, and the resulting post-conditions upon success or failure, along with any necessary steps to take.
Note that in handling any SIF_Message, an Agent may return a SIF_Ack with
SIF_Status/SIF_Code 8 (receiver is sleeping) or 7 (already
have this SIF_MsgId from you) if a duplicate message is detected. These responses are typically omitted from the handling protocols below.
Upon receipt of a generic message from the ZIS, in most cases it may be safely assumed that the message XML is well-formed, and perhaps even valid, but the Agent should take the following steps to determine whether the XML is well-formed, optionally validate the message, and check that the message is of a valid type before handing the message off to the respective message handling protocol below.
| Step | Process | Flow Control |
| 1 | If your transport layer implementation rejects XML that is not well-formed and optionally that is invalid, go to Step 3, 5, 7 or 9 depending on the extent of that implementation. Otherwise, is the XML message well-formed? | If yes, go to step 3. |
| 2 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. If your Agent can scan the incoming message as UTF-8 encoded text to locate SIF_Header/SIF_SourceId
and SIF_Header/SIF_MsgId, these values can be placed in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Otherwise include these elements with empty values, including an xsi:nil attribute value of
true on SIF_OriginalMsgId. Include a SIF_Error element with a SIF_Category
of 1 (XML Validation) and a SIF_Code of 2 (message is not well-formed). |
Go to step 12. |
| 3 | Is the root element of the message unprefixed with a local name of SIF_Message? |
If yes, go to step 5. |
| 4 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Error element with a SIF_Category
of 1 (XML Validation) and a SIF_Code of 3 (generic validation error). |
Go to step 12. |
| 5 | Is the namespace for SIF_Message a namespace of a major version of SIF your Agent supports? Is
SIF_Message/@Version present with a value that your Agent supports? (If omitted, interpret
SIF_Message/@Version as 1.1.) |
If yes, go to step 7. |
| 6 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Error element with a SIF_Category
of 12 (Generic Message Handling) and a SIF_Code of 3 (version not supported). |
Go to step 12. |
| 7 | If your Agent does not validate messages, go to step 9. Otherwise choose a validation schema based
on the value of SIF_Message/@Version. Does the message validate? |
If yes, go to step 9. |
| 8 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Error element with a SIF_Category
of 1 (XML Validation) and an appropriate SIF_Code from the corresponding choices in
Error Codes. |
Go to step 12. |
| 9 | If the namespace for SIF_Message is for a previous major version of SIF, handle according to
the specification for SIF_Message/@Version. Otherwise, is the message type (the child element of SIF_Message)
SIF_Event, SIF_Request,
SIF_Response, SIF_Ping (Push-mode only), SIF_Sleep (Push-mode only), SIF_Wakeup (Push-mode only)? |
If yes, go to step 11. |
| 10 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Error element with a SIF_Category
of 12 (Generic Message Handling) and a SIF_Code of 2 (message not supported). |
Go to step 12. |
| 11 | Process per the corresponding message handling protocol below. | Message handling is complete. |
| 12 | If your Agent is a Push-mode Agent, return the SIF_Ack to the ZIS. If your Agent is a Pull-mode
Agent send the SIF_Ack to the ZIS per SIF_Ack (Pull-Mode) above. |
Message handling is complete. |
A ZIS places a SIF_Event in your Agent's queue when an event occurs in a Zone Context with regard to an
object for which your agent
has subscribed to receive events. A SIF_Event is delivered when it is the next message pending delivery
in the queue.
An event may apply to one or more contexts; these are listed in SIF_Header/SIF_Contexts.
If SIF_Contexts is not present, the context for the event is SIF_Default.
The type of event is specified in SIF_EventObject/@Action, the corresponding data object is in SIF_EventObject.
A Change or Delete event may contain a partial object, but it must include the necessary attribute(s) and element(s)
to uniquely identify the object being changed or deleted. These keys/identifiers are typically communicated in the root attributes of
an object.
| Step | Process | Flow Control |
| 1 | Does your Agent invoke Selective Message Blocking (SMB) for all events, or does this event indicate to your Agent that it will invoke SMB? | If no, go to Step 3. |
| 2 |
Prepare a
If your Agent is a Push-Mode Agent, return the
If your Agent is a Pull-Mode Agent, send the If an error occurs, it is RECOMMENDED
that your Agent publish a |
Message handling complete. |
| 3 |
If your Agent is a Pull-Mode Agent, process the event per your Agent's business rules. When complete or if an error occurs,
acknowledge the message and remove it from your Agent's queue per If your Agent is a Push-Mode Agent, it has one of two options: process the event, then acknowledge it; or acknowledge the event, then process it. The advantage of first processing the event is the ability to return a descriptive error, if necessary, to the ZIS when acknowledging the message. The disadvantage of first processing is that if the processing is long running, the connection from the ZIS to your Agent may time out, which will lead to the event being redelivered to your Agent in another delivery attempt, to possibly run into another time-out. To avoid the latter, it is RECOMMENDED that your Push-Mode Agent first acknowledge the event, then process it, unless event processing is known to always occur within a reasonable amount of time. Agents that first acknowledge then process SHOULD persist the event locally until processing is complete, as the event is removed from your Agent's queue upon successful acknowledgement, otherwise the event will be lost in the case of an application or system error that affects your Agent's ability to complete processing of the event.
Choose an option and process the event according to your Agent's business rules. When acknowledging:
Prepare a
If an error occurs regardless of the option chosen, it is RECOMMENDED
that your Agent publish a |
Message handling complete |
A ZIS places a SIF_Request in your Agent's queue when an Agent sends a request directly to your Agent,
or when an Agent sends a request without a SIF_DestinationId and your agent is registered as the Provider
for the object requested in SIF_Query, or in the case of SIF_ExtendedQuery when your agent is registered
as the Provider of the object specified by the Requester in SIF_ExtendedQuery/SIF_DestinationProvider or
SIF_ExtendedQuery/SIF_From/@ObjectName. The ZIS will not send your Agent a SIF_ExtendedQuery
unless your Agent has registered its support for that query type using SIF_Provide or SIF_Provision.
A SIF_Request is delivered when it is the next message pending delivery
in your Agent's queue.
Any error that occurs while generating SIF_Responses
during SIF_Request handling MUST be sent to the Requester
with SIF_MorePackets set to No, at which point the response stream ends.
| Step | Process | Flow Control |
| 1 | Examine SIF_Header/SIF_Contexts to determine the context for the request; if none is specified, the context
is SIF_Default. |
Go to Step 3 if the context is supported. |
| 2 |
Prepare a Add a Add Send the |
Message handling complete. |
| 3 | Examine the SIF_Version element or elements specified in the SIF_Request message. If more than one version is supported, select
the highest version number supported. |
Go to Step 5 if a version is supported. |
| 4 |
Prepare a Add a Add Send the |
Message handling complete. |
| 5 | Examine the SIF_MaxBufferSize specified in the SIF_Request message. |
Go to Step 7 if it is greater than or equal to the minimum buffer size your Agent can support. (The buffer size of individual packets will be handled below). |
| 6 |
Using the SIF version selected in Step 1, prepare a Add a Add Send the |
Message handling complete. |
| 7 | Is SIF_ExtendedQuery specified? |
If yes, go to Step 10. |
| 6 | The query type is SIF_Query. Examine the object name being queried in SIF_QueryObject/@ObjectName. |
Go to Step 8 if the object is supported. |
| 7 |
Prepare a Add a Add Send the |
Stop processing the message. |
| 8 | Examine the query represented, if any, by SIF_ConditionGroup, or SIF_Example in the case of objects that support query-by-example, and determine whether it is supported. |
Go to Step 12 if neither SIF_ConditionGroup nor SIF_Example is present,
or if the query represented by SIF_ConditionGroup or SIF_Example is supported. |
| 9 |
Prepare a Add a Add Send the |
Stop processing the message. |
| 10 | Examine the query represented by SIF_ExtendedQuery, and determine whether it is supported.
|
Go to Step 12 if the query is supported. |
| 11 |
Prepare a Add a Add Send the |
Stop processing the message. |
| 12 |
Note that Push-Mode Agents should acknowledge receipt of the If a Push-Mode Agent elects to successfully acknowledge the request before processing, it can do so. Otherwise it should acknowledge receipt of the request upon completion of response generation. Pull-Mode Agents can choose to acknowledge receipt of the request here or at the end of response generation. Initialize packet counter to 1. |
|
| 13 | Prepare a SIF_Response message with SIF_DestinationId set to SIF_SourceId and SIF_RequestMsgId set to SIF_MsgId from the SIF_Request message.
When handling SIF_ExtendedQuery, copy the requested columns into SIF_ExtendedQueryResults/SIF_ColumnHeaders. |
|
| 14 | Add one or more of the matching objects into SIF_ObjectData, for SIF_Query, or rows into SIF_ExtendedQueryResult, for SIF_ExtendedQuery,
until no more will fit within the specified buffer size.
If no objects or rows will fit within SIF_MaxBufferSize, go to Step 15 with the SIF_Error/SIF_Category set to indicate
Request and Response and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that SIF_MaxBufferSize cannot be honored.
Otherwise, note that only requested columns are returned when processing SIF_ExtendedQuery. When processing SIF_Query, if the requester specified only
certain elements be returned, that the Responder needs to return only those elements and their parent elements and attributes. Not supporting
a requested element/attribute does not exclude the object from the response stream; include the parent elements/attributes of any missing elements,
including the object itself.
|
If no errors occur in retrieving/adding matching objects, go to step 16. |
| 15 | Set SIF_PacketNumber to the current packet counter and SIF_MorePackets to No.
Add an appropriate SIF_Error element to the SIF_Response and send the SIF_Response to the ZIS. |
Go to Step 19. |
| 16 | Set SIF_PacketNumber to the current packet counter value and set SIF_MorePackets appropriately. Send the SIF_Response to the ZIS. |
|
| 17 | Examine the SIF_Ack returned by the ZIS. |
If an error occurred, stop processing the SIF_Request message. Go to Step 19. |
| 18 | Determine if more objects or rows match the specified conditions. | If yes, increment the packet counter and go to Step 13; otherwise, go to Step 19. |
| 19 | If your Agent has not yet acknowledged receipt of the incoming request, acknowledge successful receipt of the request, or return a descriptive error to the ZIS. | Message handling complete. |
A ZIS places a SIF_Response in your Agent's queue when a responder sends a response packet to your Agent
per a SIF_Request previously sent by your Agent. It is delivered when it is the next message available for
delivery to your Agent.
| Step | Process | Flow Control |
| 1 |
SIF_RequestMsgId indicates which of your SIF_Requests this packet is in response to. Is
SIF_Error present?
|
If no, go to Step 3. |
| 2 |
The Responder's handling of your Agent's If your Agent is a Pull-Mode Agent, acknowledge the message per
If your Agent is a Push-Mode Agent: Prepare a |
Message handling complete. Any resources associated with the request can be released. |
| 3 |
If your Agent is a Pull-Mode Agent, process the response per your Agent's business rules. When complete or if an error occurs,
acknowledge the message and remove it from your Agent's queue per If your Agent is a Push-Mode Agent, it has one of two options: process the response, then acknowledge it; or acknowledge the response, then process it. The advantage of first processing the response is the ability to return a descriptive error, if necessary, to the ZIS when acknowledging the message. The disadvantage of first processing is that if the processing is long running, the connection from the ZIS to your Agent may time out, which will lead to the response being redelivered to your Agent in another delivery attempt, to possibly run into another time-out. To avoid the latter, it is RECOMMENDED that your Push-Mode Agent first acknowledge the response, then process it, unless response processing is known to always occur within a reasonable amount of time. Agents that first acknowledge then process SHOULD persist the response locally until processing is complete, as the response is removed from your Agent's queue upon successful acknowledgement, otherwise the response will be lost in the case of an application or system error that affects your Agent's ability to complete processing of the response.
Choose an option and process the response according to your Agent's business rules. When acknowledging:
Prepare a
If an error occurs regardless of the option chosen, it is RECOMMENDED
that your Agent publish a |
Message handling complete. If SIF_MorePackets is No, this is the last packet associated with the request
your Agent will receive; any resources associated with the request can be released.
|
The ZIS is pinging your Agent to see if it is reachable, "awake" and/or processing messages.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. If your Agent is "awake," include a SIF_Status element with a SIF_Code
of 1 (immediate SIF_Ack). Otherwise you may optionally notify the ZIS that
your Agent is asleep by returning a SIF_Code of 8 (receiver is sleeping).
|
|
| 2 |
Return the SIF_Ack to the ZIS.
|
Message processing complete (success). |
The ZIS has changed its state to "asleep" and is either not processing incoming messages or all incoming messages
will be acknowledged with a SIF_Ack/SIF_Status/SIF_Code value of 8 (receiver is sleeping); delivery of
queued messages to your Agent is halted. Your
Agent SHOULD avoid sending messages to the ZIS until receipt of a SIF_Wakeup message,
or be prepared to handle transport errors or the aforementioned acknowledgement.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 1 (immediate SIF_Ack). Change your Agent's ZIS state to "asleep."
|
|
| 2 |
Return the SIF_Ack to the ZIS.
|
Message processing complete (success). |
The ZIS has changed its state to "awake" and is processing incoming messages and delivering queued messages again.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Agent's Agent ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 1 (immediate SIF_Ack). Change your Agent's ZIS state to "awake."
|
|
| 2 |
Return the SIF_Ack to the ZIS.
|
Message processing complete (success). |
This section documents how Zone Integration Servers send individual messages, and the resulting post-conditions upon success or failure, along with any necessary steps to take. These correspond to each of the actions a Zone Integration Server can initiate.
A ZIS contacts a Push-Mode Agent to deliver SIF_Event, SIF_Request
and SIF_Response messages queued for the Agent. This delivery protocol starts
with a check on whether there are messages pending, as the protocol can loop as messages are delivered.
| Step | Process | Flow Control |
| 1 | Are there messages queued for the Agent? | If yes, go to Step 2. Otherwise messaging protocol complete (success). |
| 2 |
Is the state of the Agent "asleep?" If yes, the ZIS SHOULD
wait until the Agent sends a SIF_Wakeup message or re-registers in Push mode before attempting
message delivery. Otherwise the ZIS MUST
be prepared to handle transport errors/exceptions and/or the Agent responding with a SIF_Status/SIF_Code
of 8 (receiver is sleeping).
|
If no, go to Step 3. Otherwise messaging protocol complete (success). |
| 3 | Has the Agent previously invoked SMB? | If no, go to Step 6. |
| 4 |
Iterate through the Agent's queue from the message received first to the most
recently received message. Stop at the first SIF_Response or
SIF_Request in the queue, if one exists.
|
If one exists, it is the next message to be delivered. Go to Step 7. |
| 5 |
The only messages queued for the Agent are SIF_Events; try again later, or after a SIF_Response or
SIF_Request arrives, or after the Agent has ended SMB by sending a final SIF_Ack.
|
Messaging protocol complete (no message needs to be delivered). |
| 6 | The next message to be delivered is the message received first in the Agent's queue. | |
| 7 |
Is SIF_Header/SIF_Security present in the SIF_Message
with SIF_EncryptionLevel,
SIF_AuthenticationLevel, or both?
|
If no, the message delivery encryption/authentication levels are the minimum encryption/authentication levels set up for the Zone. Go to Step 9. |
| 8 | The ZIS MUST guarantee that the minimum encryption and/or authentication levels specified are respected when delivering this message. Use the higher of these and the Zone's minimum encryption and/or authentication levels during message delivery. | |
| 9 | If a connection is already open to the Push-Mode Agent from a previously delivered message, are the encryption and authentication levels greater than or equal to those needed for the delivery of this message? | If there is no connection open, go to Step 11. If there is and the encryption/authentication levels are adequate for delivery, go to Step 13. |
| 10 | Attempt to renegotiate the encryption/authentication levels for the connection, or close the connection and attempt to open a new connection with adequate encryption/authentication levels. | Go to Step 12. |
| 11 | If the registered transport layer is known to not provide adequate encryption/authentication levels (e.g. SIF HTTP), go to Step 12. Otherwise attempt to open a connection to the Agent with adequate encryption/authentication levels, using the appropriate transport layer. | |
| 12 |
Was a connection opened or renegotiated with adequate encryption/authentication levels?
If no, the message cannot be delivered; remove it from the Agent's queue. It is RECOMMENDED
that your ZIS log the error. Your ZIS MUST post a SIF_LogEntry
Add event with the appropriate error category and code, containing a copy of the SIF_Header
of the queued message. SIF_LogEntry/SIF_Desc MUST contain
the SIF_SourceId of the Agent that failed to receive the message.
|
Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (error). |
| 13 | Send the message to the Agent over the connection. | |
| 14 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 24. |
| 15 |
Is SIF_Status/SIF_Code 1 (immediate SIF_Ack)?
|
If no, go to Step 17. |
| 16 | The Agent has successfully acknowledged receipt of the message; remove it from the Agent's queue. | Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (success). |
| 17 |
Is SIF_Status/SIF_Code 2 (intermediate SIF_Ack)?
|
If no, go to Step 21. |
| 18 |
The Agent is invoking SMB. Is the delivered message a SIF_Event?
|
If yes, go to Step 20. |
| 19 |
The Agent has violated protocol; remove the message from the Agent's queue. It is RECOMMENDED
that your ZIS log the error. Your ZIS MUST post a SIF_LogEntry
Add event with the appropriate error category of 13 (SMB Error)
and code 2 (SMB can only be invoked for SIF_Event), containing a copy of the SIF_Header
of the queued message. SIF_LogEntry/SIF_Desc MUST contain
the SIF_SourceId of the Agent that committed the protocol error.
|
Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (error). |
| 20 |
The Agent has invoked SMB on this SIF_Event. Persist that the Agent has invoked SMB along with
the SIF_MsgId of the event. The event stays in the agent's queue as blocked, and all other events
are frozen until the Agent eventually ends SMB by sending a final SIF_Ack
with this SIF_MsgId in SIF_OriginalMsgId, or by sending a SIF_Wakeup or
by re-registering.
|
Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (success). |
| 21 |
Is SIF_Status/SIF_Code 8 (receiver is sleeping)?
|
If no, go to Step 23. |
| 22 | The Agent is asleep. Re-attempt delivery later. | Messaging protocol complete (success). |
| 23 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
7 (already have this SIF_MsgId). The ZIS cannot correct this, as the SIF_MsgId
originates from an Agent and can't be changed without other repercussions. Remove the message from
the Agent's queue. It is RECOMMENDED
that your ZIS log the error. Your ZIS MUST post a SIF_LogEntry
Add event with the appropriate error category and code, containing a copy of the SIF_Header
of the queued message. SIF_LogEntry/SIF_Desc MUST contain
the SIF_SourceId of the Agent that did not receive the message.
|
Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (error). |
| 24 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. If SIF_Category does not indicate a transport error, remove the message from the Agent's
queue. Otherwise re-attempt delivery of this message later. It is RECOMMENDED
that your ZIS log the error. Your ZIS MAY post a SIF_LogEntry
Add event with the appropriate error category and code, containing a copy of the SIF_Header
of the queued message. SIF_LogEntry/SIF_Desc MUST contain
the SIF_SourceId of the Agent that indicated the error.
|
Go to Step 1 to start delivery of the next queued message, if desired. Otherwise messaging protocol complete (error). |
A ZIS can "ping" a Push-Mode Agent or check that it's "awake" by sending
a SIF_Ping message to the Agent. If the Agent returns
a successful acknowledgement, it is awake; the Agent may also reply that it is asleep. As
a Push-Mode Agent may be offline completely, Zone Integration Servers should be prepared to handle transport errors directly
or wrapped in a SIF_Ack/SIF_Error by underlying code.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
the Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Ping
element in SIF_SystemControlData.
|
Send SIF_Message to Agent over appropriate transport.
|
| 2 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 8. |
| 3 |
Is SIF_Status/SIF_Code 1?
|
If no, go to Step 5. |
| 4 | The Agent is awake. | Messaging protocol complete (success). |
| 5 |
Is SIF_Status/SIF_Code 8 (receiver is sleeping)?
|
If no, go to Step 7. |
| 6 | The Agent is asleep. | Messaging protocol complete (success). |
| 7 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
7 (your ZIS sent a duplicate SIF_MsgId).
|
Messaging protocol complete (failure). |
| 8 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included.
|
Messaging protocol complete (failure). |
A ZIS can send
a SIF_Sleep message to a Push-Mode Agent to change its state
to "sleeping," indicating that it will either be offline or acknowleding incoming messages with a SIF_Status/SIF_Code
of 8 (receiver is sleeping), and that it will not be delivering messages to the Agent
until it "wakes up"
by sending a SIF_Wakeup message.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Sleep
element in SIF_SystemControlData.
|
Send SIF_Message to Agent over appropriate transport.
|
| 2 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 6. |
| 3 |
Is SIF_Status/SIF_Code 1?
|
If no, go to Step 5. |
| 4 |
The Agent has successfully acknowledged your SIF_Sleep and should not be expecting
further message delivery until your ZIS sends a SIF_Wakeup.
|
Messaging protocol complete (success). |
| 5 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (Agent is asleep) or 7 (your ZIS sent a duplicate SIF_MsgId).
|
Messaging protocol complete (failure). |
| 6 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included.
|
Messaging protocol complete (failure). |
A ZIS can send a SIF_Wakeup message to a Push-Mode Agent to change its state to "awake;" i.e., that it is ready to process incoming messages and deliver queued messages again.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Message/SIF_SystemControl message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place an empty SIF_Wakeup
element in SIF_SystemControlData.
|
Send SIF_Message to Agent over appropriate transport.
|
| 2 |
Receive SIF_Ack in response.
Is SIF_Error present?
|
If yes, go to Step 6. |
| 3 |
Is SIF_Status/SIF_Code 1?
|
If no, go to Step 5. |
| 4 | The Agent has successfully acknowledged your "awake" status. | Messaging protocol complete (success). |
| 5 |
Messaging protocol has failed due to a SIF_Status/SIF_Code of
8 (Agent is asleep) or 7 (your ZIS sent a duplicate SIF_MsgId).
|
Messaging protocol complete (failure). |
| 6 |
Messaging protocol has failed due to a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included.
|
Messaging protocol complete (failure). |
This section documents how Zone Integration Servers should respond to incoming messages, and the resulting post-conditions upon success or failure, along with any necessary steps to take.
Note that in handling any SIF_Message, the ZIS can return a SIF_Ack with
SIF_Status/SIF_Code 8 (receiver is sleeping) or 7 (already
have this SIF_MsgId from you) if a duplicate message is detected. These responses are omitted from the handling protocols below.
When a message is received, the ZIS should first validate
the XML message. If the message is not SIF_Register, the ZIS should
determine whether the sender is registered in the zone. If errors are
found, a SIF_Ack with a SIF_Error element should be returned to the caller and no further processing should occur.
If no errors are found, message processing proceeds according to message type.
Subsequent message processing sections are assured of receiving well-formed and/or valid XML,
and all non-SIF_Register message processing sections are assured that the agent is indeed registered with the zone.
| Step | Process | Flow Control |
| 1 | Validate incoming XML message. Message validation is optional. The Version attribute of SIF_Message can be used
to indicate the appropriate message definition. |
If not performing message validation, go to Step 3 if XML is well-formed. If performing message validation, go to Step 3 if message is well-formed and valid. |
| 2 | Prepare a SIF_Ack containing a SIF_Error element.
(Note that if XML is not well-formed, or invalid and the well-formed XML is not made available by the XML parser,
SIF_SourceId and SIF_MsgId will not be available from the incoming XML message.
If this is the case, include SIF_OriginalSourceId and SIF_OriginalMsgId in the SIF_Ack as empty elements with xsi:nil set to true as necessary to indicate the current message.) Set SIF_Error/SIF_Category to indicate XML Validation and place the appropriate error code and description in SIF_Error/SIF_Code and SIF_Error/SIF_Desc.
Place any additional parser information into SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to caller.
If it can be determined the message is a SIF_Response, see SIF_Response Handling below, Step 13, to send an error SIF_Response to the requester. |
Stop processing this message. |
| 3 | Examine the Version attribute of the message. | If the version is supported, go to Step 5. |
| 4 | Prepare a SIF_Ack containing a SIF_Error element.
Set SIF_Error/SIF_Category to Generic Message Handling, indicating that the message is not supported in SIF_Error/SIF_Code and SIF_Error/SIF_Desc.
Return the SIF_Ack to the caller. If this message is a SIF_Response, see SIF_Response Handling below, Step 13, to send an error SIF_Response to the requester. |
Stop processing this message. |
| 5 | Examine message's SIF_Header to retrieve the SIF_SourceId and the message to get the message type. If message type is not SIF_Register, determine if the sender identified by SIF_SourceId is registered. |
If message type is SIF_Register or if the sender's SIF_SourceId is registered, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element.
Set SIF_Error/SIF_Category to Access and Permissions, indicating that the sender is not registered in SIF_Error/SIF_Code and SIF_Error/SIF_Desc.
Return the SIF_Ack to the caller. If this message is a SIF_Response, see SIF_Response Handling below, Step 13, to send an error SIF_Response to the requester. |
Stop processing the message. |
| 7 | Forward message to the proper handler based on the message type. |
Before an agent can participate in a zone, it must register itself in order to provide the data that the ZIS needs to interact with the agent. This process is handled using a SIF_Register message.
| Step | Process | Flow Control |
| 1 | If ZIS implementation limits SIF_SourceId values in some way, examine SIF_SourceId and determine whether it is valid. |
If implementation allows any SIF_SourceId or if the SIF_SourceId is valid, go to Step 3. |
| 2 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Registration and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that SIF_SourceId is invalid. Return the SIF_Ack to the caller. |
Stop processing this message. |
| 3 | If ZIS implementation requires previous permissions to register, examine SIF_SourceId and determine whether sender is permitted to register. |
If implementation allows any sender to register or if sender is permitted to register, go to Step 5. |
| 4 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Access and Permissions and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the lack of permission to register. Return the SIF_Ack to the caller. |
Stop processing this message. |
| 5 | Examine SIF_Version element(s) and determine if the ZIS can handle the version(s). |
Go to Step 7 if the ZIS can handle the SIF version(s) specified by agent. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Registration and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that the ZIS cannot handle SIF messages in a version requested. Place the unsupported version in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing this message. |
| 7 | Examine SIF_MaxBufferSize and verify that it is greater than or equal to the minimum value for the ZIS. |
Go to Step 9 if SIF_MaxBufferSize is large enough. |
| 8 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Registration and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that the SIF_MaxBufferSize is too small to be supported by the ZIS. Return the SIF_Ack to the caller |
Stop processing this message. |
| 9 | If the supplied value of SIF_Mode is Push, verify that the SIF_Protocol element is provided and that the protocol information appears sufficient for contacting the agent in Push mode. |
Go to Step 11 if SIF_Mode is Pull or SIF_Protocol information appears valid. |
| 10 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Registration and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that the protocol is not supported or a secure transport is required. Return the SIF_Ack to the caller. |
Stop processing this message. |
| 11 | Store data from the SIF_Register message into the agent's database profile. |
|
| 12 | Prepare a SIF_Ack containing a SIF_Status element indicating success,
placing the agent's access control permissions in SIF_Status/SIF_Data/SIF_AgentACL.
Return the SIF_Ack to the caller. |
Stop processing this message. |
An agent may also send the SIF_Register message when already registered. In this case, the ZIS should re-register the agent in the same manner as defined for initial registration. Any existing provision and subscription entries, as well as any pending messages, maintained by the ZIS for the agent should remain intact. Upon successful re-registration, any new or updated registration settings for the agent, including push mode protocol information, take effect after the ZIS has returned a successful SIF_Ack for the SIF_Register message.
When an agent is going be removed from a Zone, the agent must send a SIF_Unregister message. When a ZIS receives this message from an agent, it performs those steps—ignoring SIF_Ack preparation and delivery—outlined for the SIF_Unprovide and SIF_Unsubscribe messages for any agent provisions or subscriptions, respectively. The ZIS then discards any messages pending for the agent. The ZIS will also remove any registration information and remove the agent from its list of registered agents.
It is recommended that the ZIS not remove access control data from its database as a replacement agent may be installed. Keeping the access permissions is optional, however.
| Step | Process | Flow Control |
| 1 | Examine message and retrieve the SIF_SourceId of the message. The ZIS must remove the agent from its list of registered agents. Perform SIF_Unprovide functionality for any objects the agent is providing. Perform SIF_Unsubscribe functionality for any objects to which the agent is subscribed. Discard any pending messages for the agent. |
|
| 2 | Prepare a SIF_Ack containing a SIF_Status element indicating success. Return the SIF_Ack to caller. |
Stop processing the message. |
An agent makes an object available to be requested by a process called Provision that is represented by the SIF_Provide message.
The SIF_Provide message can contain provision requests for multiple objects.
The ZIS must treat all of the objects as a set; if there is an error with one of the objects then there should be no change to the Providers database.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack. |
Go to Step 3. |
| 2 | Examine the message to determine whether any more objects are being provided. | Go to Step 11 if there are no further object provisions to process for this message. |
| 3 | Retrieve the name of the next object to be provided. If not otherwise performed in initial message validation, check whether the object name is valid (e.g. valid/supported object, not SIF_ZoneStatus). |
If object name is valid, go to Step 5. |
| 4 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Provision and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the object is invalid. Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 14. |
| 5 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that each SIF_Context supplied in SIF_Contexts is supported. |
If they are all supported, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a context is not supported. Place the name of the context in SIF_Error/SIF_ExtendedDesc. |
Go to Step 14. |
| 7 | Using the SIF_SourceId, consult the ACL to determine if the sender has the proper access and permissions for this object in each of the specified contexts. |
If sender has the proper access and permissions, go to Step 9. |
| 8 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Access and Permissions. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the sender lacks permission to provide this object. Place the name of the object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 14. |
| 9 | Check the Providers database to see if this object has already been provided in the contexts specified. | If the object does not have a provider in the contexts specified, go to Step 11. |
| 10 | Is the current provider the same as the SIF_SourceId of this message? |
If the provider differs from the SIF_SourceId of this message, go to Step 14. Otherwise go to Step 2. |
| 11 | Add a record in the Providers database to indicate that SIF_SourceId is the provider of this object in the given contexts.
If an error occurs, add a SIF_Error element to the SIF_Ack. |
If an error occurs, go to Step 13; otherwise go to Step 2. |
| 12 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Provision and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to
indicate that the object already has a provider. Place the name of the provider in SIF_Error/SIF_ExtendedDesc. |
Go to Step 14. |
| 13 | Add a SIF_Status element indicating success to the SIF_Ack. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 14 | Undo all changes to the Providers database. Return the SIF_Ack to the caller. |
Stop processing the message. |
If an agent wishes to withdraw an object previously provided, the SIF_Unprovide message is used.
The SIF_Unprovide message can contain multiple objects.
The ZIS must treat all of the objects as a set; if there is an error with one of the objects then there should be no change to the Providers database.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack. |
Go to Step 3. |
| 2 | Examine the message to determine whether any more objects are being unprovided. | Go to Step 7 if there are no further objects to process for this message. |
| 3 | Examine the message and retrieve the name of an object to be unprovided. If not otherwise performed in initial message validation, check whether the object name is valid (e.g. valid/supported object, not SIF_ZoneStatus). |
Go to Step 5 if the object name is valid. |
| 4 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Provision and set
SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the object is invalid. Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 10. |
| 5 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that each SIF_Context supplied in SIF_Contexts is supported. |
If they are all supported, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a context is not supported. Place the name of the context in SIF_Error/SIF_ExtendedDesc. |
Go to Step 10. |
| 7 | If it exists, remove the records in the Providers database that marks SIF_SourceId as the provider of this object for the given contexts.
If an error occurs, add a SIF_Error element to the SIF_Ack. |
If an error occurs, go to Step 10. |
| 8 | Leave all pending SIF_Requests for the object in the responder's queue,
as they may include SIF_Requests routed explicitly to the responder using SIF_DestinationId. |
Go to Step 2. |
| 9 | Add a SIF_Status element indicating success to the SIF_Ack. Return the SIF_Ack to the caller |
Stop processing the message. |
| 10 | Undo all changes to the Providers database. Return the SIF_Ack to the caller. |
Stop processing the message. |
An agent requests to receive SIF_Events for an object by a process called Subscription that is represented by the SIF_Subscribe message.
The SIF_Subscribe message can contain subscription requests for multiple objects.
The ZIS must treat all of the objects as a set, if there is an error with one of the objects then there should be no change to the Subscribers database.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack. |
Go to Step 3. |
| 2 | Examine the message to determine whether any more subscriptions need to be processed. | Go to Step 9 if there are no further subscriptions to process in this message. |
| 3 | Retrieve the name of the next object to be subscribed to. If not otherwise performed in initial message validation, check whether the object name is valid (e.g., valid/supported object with events reported). | If the object name is valid, go to Step 5. |
| 4 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Subscription and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the object is invalid. Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 12. |
| 5 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that each SIF_Context supplied in SIF_Contexts is supported. |
If they are all supported, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a context is not supported. Place the name of the context in SIF_Error/SIF_ExtendedDesc. |
Go to Step 12. |
| 7 | Using the SIF_SourceId, consult the ACL to determine if the sender has the proper access and permissions for this object and contexts. |
If sender has the proper access and permissions, go to Step 9. |
| 8 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Access and Permissions. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the sender lacks permission to subscribe to this object. Place the name of the object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 12. |
| 9 | Check the Subscribers database to see if the caller is already subscribed to this object for the specified contexts. | If the caller is already subscribed to this object, go to Step 2. |
| 10 | Add a record in the Subscribers database to indicate that SIF_SourceId is a subscriber of this object's SIF_Events in the specified contexts.
If an error occurs, add a SIF_Error element to the SIF_Ack. |
If an error occurs go to Step 12; otherwise go to Step 2. |
| 9 | Add a SIF_Status element indicating success to the SIF_Ack. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 12 | Undo all changes to the Subscribers database. Return the SIF_Ack to the caller. |
Stop processing the message. |
If an agent wishes to cancel one or more subscriptions, the SIF_Unsubscribe message is used. Events already queued for delivery prior to unsubscription will be delivered.
The SIF_Unsubscribe message can contain subscription requests for multiple objects. The ZIS must treat all of the objects as a set, if there is an error with one of the objects then there should be no change to the Subscribers database.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack. |
Go to Step 3. |
| 2 | Examine the message to determine whether any more unsubscriptions need to be processed. | Go to Step 6 if there are no further objects to process in the message. |
| 3 | Retrieve the name of the next object. If not otherwise performed in initial message validation, check whether the object name is valid (e.g. valid/supported object with events reported). | If the object name is valid, go to Step 5. |
| 4 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Subscription and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the object is invalid. Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. |
Go to Step 9. |
| 5 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that each SIF_Context supplied in SIF_Contexts is supported. |
If they are all supported, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a context is not supported. Place the name of the context in SIF_Error/SIF_ExtendedDesc. |
Go to Step 12. |
| 7 | If it exists, remove the record in the Subscribers database that marks SIF_SourceId as a subscriber of this object's SIF_Events in the specified contexts. If an error occurs, add a SIF_Error element to the SIF_Ack. |
If an error occurs go to Step 9, otherwise go to Step 2. |
| 8 | Add a SIF_Status element indicating success to the SIF_Ack. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 9 | Undo all changes to the Subscribers database. Return the SIF_Ack to the caller. |
Stop processing the message. |
An Agent is registering its support for various messages with regard to various objects. Settings supplied replace any previously recorded settings for the Agent.
| Step | Process | Flow Control |
|---|---|---|
| 1 | Prepare SIF_Ack. |
|
| 2 | Process SIF_ProvideObjects as provide. |
On error go to step 13. |
| 3 | Process objects not in SIF_ProvideObjects as unprovide. |
On error go to step 13. |
| 4 | Process SIF_SubscribeObjects as subscribe. |
On error go to step 13. |
| 5 | Process objects not in SIF_SubscribeObjects as unsubscribe. |
On error go to step 13. |
| 6 | Process SIF_PublishAddObjects. |
On error go to step 13. |
| 7 | Process SIF_PublishChangeObjects. |
On error go to step 13. |
| 8 | Process SIF_PublishDeleteObjects. |
On error go to step 13. |
| 9 | Process SIF_RequestObjects. |
On error go to step 13. |
| 10 | Process SIF_RespondObjects. |
On error go to step 13. |
| 11 | Save changes. | |
| 12 | Return success SIF_Ack. |
Stop processing. |
| 13 | Roll back any changes. | |
| 14 | Return error SIF_Ack. |
Stop processing. |
When an application has made a change in an object that is part of the Zone and for which the application has declared the ability to generate SIF_Events,
the agent will send a SIF_Event message to its Zone Integration Server so the framework may distribute it.
| Step | Process | Flow Control |
| 1 | Examine message and retrieve the name of the object. Check whether the object name is valid (e.g. valid/supported object with events reported). | If object name is valid, go to Step 3. |
| 2 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Event Reporting and set
SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the event is invalid.
Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 3 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that each SIF_Context supplied in SIF_Contexts is supported. |
If they are all supported, go to Step 5. |
| 4 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a context is not supported. Place the name of the context in SIF_Error/SIF_ExtendedDesc.
Return the SIF_Ack to the caller. |
Stop processing the message. |
| 5 | Using the SIF_SourceId, consult the ACL to determine if the sender has the proper access and permissions for this object in the specified contexts. |
If sender has the proper access and permissions, go to Step 7. |
| 6 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Access and Permissions. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the sender lacks permission to publish events pertaining to this object (use general SIF_Event error code, or specific Add, Change, Delete codes). Place the name of the object in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 7 | Check the Subscriber database to see if there are any subscribers in the specified contexts for the SIF_Event. |
Go to Step 9 if there are no subscribers for this object. |
| 8 |
Create a new message for this SIF_Event and place a copy into each subscribing agent's queue. If more than
one context is specified for the event, only one copy of the event is placed in the subscribing agent's queue.
If the event cannot be placed into an individual agent's queue due to the agent's maximum buffer size or
because the subscribing agent does not support the message version of the SIF_Event,
it is recommended that the ZIS log the inability to deliver the event.
In addition, the ZIS MUST report a SIF_LogEntry event with the appropriate error category and code,
containing a copy of the SIF_Header from the original message.
SIF_LogEntry/SIF_Desc must contain the SourceId of the agent that has failed to receive the message.
|
|
| 9 | Prepare a SIF_Ack containing a SIF_Status element indicating success. Return a SIF_Ack to the caller. |
Stop processing the message. |
When an agent needs information from a Zone context it sends a SIF_Request message to the ZIS.
If the SIF_Request's header does not contain a SIF_DestinationId element, the ZIS will route the message to the Provider of the object referenced in the SIF_Request.
If the header contains a SIF_DestinationId, the ZIS will route the message to the application referenced in the SIF_DestinationId if the security policies of the zone permit such routing. The ZIS will return a SIF_Ack message to the requesting agent to indicate whether or not it was able to process the SIF_Request message.
After the ZIS returns a success SIF_Ack to the requester, the ZIS will route the SIF_Request to the responder and the requesting agent may expect to receive one or more SIF_Response messages sent by the responder. However, the responder may not be currently on-line or it may not be able to immediately satisfy the SIF_Request. Therefore, requesting agents must not depend upon a timely response to their SIF_Request.
If the ZIS returns an error SIF_Ack, the requesting agent will not receive any SIF_Response messages from a responder.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack. |
|
| 2 | Retrieve the name of the object from the ObjectName attribute of SIF_Query/SIF_QueryObject and check whether it's a valid/supported object. |
Go to Step 4 if the object name is valid. |
| 3 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Request and Response and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the object name is invalid. Place the name of the invalid object in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 4 | If no SIF_Context is specified, the context is SIF_Default. Otherwise check that the context supplied in SIF_Contexts is supported. If more
than one context is specified, go to Step 5. |
If the context is supported, go to Step 6. |
| 5 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Generic Message Handling.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate a specified context is not supported or that multiple contexts are not supported,
depending on the error. Place the name of the context in SIF_Error/SIF_ExtendedDesc.
Return the SIF_Ack to the caller. |
Stop processing the message. |
| 6 | Using the SIF_SourceId, consult the ACL to determine if the sender has the proper access and permissions for this object in the applicable contexr. |
If sender has the proper access and permissions, go to Step 8. |
| 7 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Access and Permissions. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the sender lacks permission to request this object. Place the name of the object in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 8 | Examine the SIF_Request header looking for a SIF_DestinationId |
Go to Step 11 if a SIF_DestinationId was located. |
| 9 | No SIF_DestinationId was found. Examine the Providers database to locate the responder for the requested object in the applicable context. |
Go to Step 12 if a Provider was located. |
| 10 | Add a SIF_Error element with the SIF_Error/SIF_Category set to indicate Request and Response and SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate that no provider was found. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 11 | A SIF_DestinationId was specified indicating the responder. Confirm that the agent specified in SIF_DestinationId has permission to send SIF_Response messages for the requested data object in
the applicable context. |
Go to Step 10 if the agent does not have the necessary permission. |
| 12 | If it can be determined from ACL settings or settings recorded by SIF_Provision and/or SIF_Provide that the Responder
cannot handle
a SIF_Query for a given object or SIF_ExtendedQuery for any referenced object, or that the Responder doesn't handle
extended queries in general, add a SIF_Error element with the applicable SIF_Error/SIF_Category and SIF_Error/SIF_Code (object not supported,
query not supported, or SIF_ExtendedQuery not supported). Place an appropriate error message in SIF_Desc and/or SIF_ExtendedDesc.
Return the SIF_Ack to the caller. |
Stop processing the message. |
| 13 |
Deposit the SIF_Request in the responder's queue.
If the request cannot be placed into an individual agent's queue due to the agent's maximum buffer size or because the destination agent
does not support the message version of the SIF_Request, it is recommended that the ZIS log the inability to deliver the request.
In addition, the ZIS MUST report a SIF_LogEntry event with the appropriate error category and code,
containing a copy of the SIF_Header from this message. SIF_LogEntry/SIF_Desc MUST
contain the SourceId of the agent that has failed to receive the request.
|
|
| 14 | Return a SIF_Ack, with SIF_Status set to 0, to the caller to indicate that SIF_Request has been sent. |
Stop processing the message. |
When receiving a SIF_Response packet from an agent responding to a SIF_Request, the ZIS MUST perform the validation
protocol below.
| Step | Process | Flow Control |
|---|---|---|
| 1 | Prepare a SIF_Ack. |
|
| 2 | Using the supplied SIF_RequestMsgId, look up the SIF_Request that initiated this response. |
Go to Step 4 if the SIF_Request is found. |
| 3 | Add a SIF_Error element to the SIF_Ack. Set SIF_Error/SIF_Category to indicate Request and Response and set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the SIF_RequestMsgId is invalid. Place SIF_RequestMsgId in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Stop processing the message. |
| 4 | Examine the SIF_MaxBufferSize specified in the SIF_Request message and compare it to the size of the SIF_Response packet. |
If the SIF_Response packet is smaller than or equal to the SIF_MaxBufferSize specified in the original request, go to Step 6. |
| 5 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate indicate Request and Response. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the SIF_MaxBufferSize is incorrect. Place a description of the SIF_MaxBufferSize and the actual size of the message received in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Go to step 13. |
| 6 | Examine the SIF_DestinationId specified in the SIF_Response and compare it to the SIF_SourceId of the original request. |
If the SIF_DestinationId is correct, go to Step 8. |
| 7 | Prepare a SIF_Ack containing a SIF_Error element.
Set SIF_Error/SIF_Category to indicate indicate Request and Response.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the SIF_DestinationId is incorrect.
Place a description of the SIF_DestinationId specified and the SIF_DestinationId expected in SIF_Error/SIF_ExtendedDesc.
Return the SIF_Ack to the caller. |
Go to step 13. |
| 8 | Examine the SIF_PacketNumber specified in the SIF_Response.
If this is the first SIF_Response packet received, the SIF_PacketNumber must be set to a value of 1.
Subsequent packets must be received in order with the SIF_PacketNumber set to 1 + the previous SIF_PacketNumber. |
If the SIF_PacketNumber is correct, go to Step 10. |
| 9 | Prepare a SIF_Ack containing a SIF_Error element.
Set SIF_Error/SIF_Category to indicate indicate Request and Response.
Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the SIF_PacketNumber is incorrect.
Place a description of the SIF_PacketNumber specified and the SIF_PacketNumber expected in SIF_Error/SIF_ExtendedDesc.
Return the SIF_Ack to the caller. |
Go to step 13. |
| 10 | Examine the SIF_Version specified in the SIF_Response and compare it to the SIF_Versions allowed in the original request. |
If the SIF version matches one of the SIF Versions requested in the SIF_Request, go to Step 12. |
| 11 | Prepare a SIF_Ack containing a SIF_Error element. Set SIF_Error/SIF_Category to indicate Request and Response. Set SIF_Error/SIF_Code and SIF_Error/SIF_Desc to indicate the SIF_Version is incorrect. Place a description of the version of the SIF_Response and versions allowed by the SIF_Request in SIF_Error/SIF_ExtendedDesc. Return the SIF_Ack to the caller. |
Go to step 13. |
| 12 | Place the SIF_Response packet in the requesting agent's queue. |
Message processing is complete. Stop processing the message. |
| 13 |
Prepare a Add a Add
Return the |
Stop processing the message. The ZIS must also guarantee that no additional
The ZIS may remove the |
The ZIS must maintain a reliable list of all open SIF_Requests in order to satisfy the Quality of Service validations that are applied to SIF_Responses above. It is envisioned that once a SIF_Response has been completed, either by receiving the last packet or by failing one of the validations applied below, knowledge of the initiating SIF_Request will no longer need to be maintained by the ZIS. If the responding agent attempts to send any more SIF_Responses for a failed SIF_Request, it will automatically fail at Step 2 and get the error response specified in Step 3. Notification of the failed SIF_Response would have already been sent to the requesting agent.
There remain three cases where a requesting agent will not receive a complete SIF_Response for a request.
SIF_Response.SIF_Response by sending a SIF_Response with the SIF_MorePackets element set to "No".SIF_Response but the ZIS is unable to parse the message enough to read the SIF_RequestMsgId. If this case occurs, and the responding agent sends a subsequent SIF_Response that is parseable, it is likely that the requesting agent will be notified of the problem because subsequent SIF_Response packets will not pass the SIF_PacketNumber validation.Management of the SIF_Request cache that is maintained by the ZIS is left up to the ZIS implementation. The ZIS is required to maintain the SIF_Requests for a reasonable amount of time. If the ZIS eventually removes SIF_Requests that have been cached for a long period of time, that option must be able to be configured by the ZIS administrator.
When an open request cache entry is removed by the administrator or a timeout of the record, the ZIS should publish a SIF_LogEntry and a SIF_Response/SIF_Error indicating the reason it was removed.
An Agent is pinging your ZIS to see if it is reachable, "awake" and/or processing messages.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. If your ZIS is "awake," include a SIF_Status element with a SIF_Code
of 0 (success). Otherwise you may optionally notify the Agent that
your ZIS is asleep by returning a SIF_Code of 8 (receiver is sleeping).
|
|
| 2 |
Return the SIF_Ack to the Agent.
|
Message processing complete (success). |
The Agent wants its state changed to "asleep." Upon successful state change, your
ZIS SHOULD avoid sending messages to a Push-Mode Agent until receipt of a SIF_Wakeup message
or that Agent re-registers, or be prepared to handle transport errors or the aforementioned acknowledgement. Whether the
Agent is registered in Push or Pull mode, this state is communicated
to other Agents in SIF_ZoneStatus and MUST be persisted accordingly. In addition to sending
a SIF_Wakeup or SIF_Register, a Pull-Mode Agent can also change its state to "awake" by sending a
SIF_GetMessage.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 0 (success). Change the state of the Agent to "asleep."
|
|
| 2 |
Return the SIF_Ack to the Agent.
|
Message processing complete (success). |
An Agent wants its state changed to "awake," notifying the ZIS and other Agents of the state change. A ZIS MUST
persist this state in order to communicate it to other Agents via SIF_ZoneStatus. When a Push-Mode Agent changes its state
to "awake," the ZIS may also resume delivery of queued messages to the Agent.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 0 (success). Change the Agent's state to "awake."
|
|
| 2 |
Return the SIF_Ack to the Agent.
|
Message processing complete (success). |
An Agent is requesting the status of the zone.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 0 (success). Reflect the current state of the zone in SIF_Status/SIF_Data/SIF_ZoneStatus.
|
|
| 2 |
Return the SIF_Ack to the Agent.
|
Message processing complete (success). |
An Agent is requesting its access control permissions.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. Include a SIF_Status element with a SIF_Code
of 0 (success). Communicate the Agent's ACL permissions in SIF_Status/SIF_Data/SIF_AgentACL.
|
|
| 2 |
Return the SIF_Ack to the Agent.
|
Message processing complete (success). |
A Pull-Mode Agent is requesting the next message in its queue.
| Step | Process | Flow Control |
| 1 |
Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. Place the incoming SIF_Header/SIF_SourceId and SIF_Header/SIF_MsgId
in SIF_OriginalSourceId and SIF_OriginalMsgId,
respectively. If the Agent sending SIF_GetMessage is registered as a Pull-Mode Agent, go to step 3.
|
|
| 2 |
The Agent is a Push-Mode Agent and is not allowed to send SIF_GetMessage.
Include a SIF_Error/SIF_Category of 5 (Registration) and a
SIF_Error/SIF_Code of 9 (Agent is registered in Push mode).
Populate SIF_Desc and optionally SIF_ExtendedDesc
as desired. Return the SIF_Ack to the Agent.
|
Message processing complete. |
| 3 | If the recorded state of the Pull-Mode Agent is "asleep," change that state to "awake." Is there a message available in the Agent's message queue, subject to Selective Message Blocking? If yes, go to step 5. | |
| 4 |
There is no message currently available for the Agent.
Include a SIF_Status/SIF_Code of 9 (no messages available).
Return the SIF_Ack to the Agent.
|
Message processing complete. |
| 5 |
The next available message in the Agent's queue, subject to Selective Message Blocking, can be delivered (it will be removed from the queue later
per successful handling of a SIF_Ack from the Pull-Mode Agent). If SIF_Security is specified
on the message and the connection from the Pull-Mode Agent does not meet the specified minimum encryption
and/or authentication levels, or if the connection does not meet minimum encryption/authentication levels in
the Zone, remove the message from the Agent's queue and return an appropriate SIF_Error.
Otherwise include a SIF_Status/SIF_Code of 0 (success) and place
the message in SIF_Status/SIF_Data.
|
Message processing complete. |
A Push-Mode Agent is sending a final SIF_Ack to end Selective Message Blocking (SMB).
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. |
|
| 2 | Is SIF_Status/SIF_Code 3 (final SIF_Ack)? |
If yes, go to Step 3. |
| 2 |
The Agent has violated protocol. End SMB if it has been invoked by the
Agent and remove the blocked
It is RECOMMENDED
that your ZIS log the error. Your ZIS MAY post a |
Return the SIF_Ack to the Agent. Message handling complete (error). |
| 3 |
Does SIF_OriginalMsgId match the SIF_MsgId for the SIF_Event that
was blocked in SMB, if any?
|
If yes, go to Step 5. |
| 4 |
The Agent has violated protocol. As there can be only one event blocked by SMB, end SMB for the agent
and remove the blocked
It is RECOMMENDED
that your ZIS log the error. Your ZIS MAY post a |
Return the SIF_Ack to the Agent. Message handling complete (error). |
| 5 | SMB has been ended by the Agent. Removed the blocked SIF_Event from the Agent's queue.
Place 0 in SIF_Status/SIF_Code. |
Return the SIF_Ack to the Agent. Message handling complete (success). |
A Pull-Mode Agent is acknowledging a message it has retrieved using SIF_GetMessage. This typically
leads to the message in question being removed from the Agent's queue. The Agent may also invoke Selective Message Blocking when acknowledging
an event, blocking delivery of subsequent SIF_Events until Selective Message Blocking is ended by the Agent.
| Step | Process | Flow Control |
| 1 | Prepare a SIF_Ack message with
SIF_Header containing a new GUID in SIF_MsgId,
your Zone ID in SIF_SourceId and the current time in SIF_Timestamp; other SIF_Header
elements do not apply. |
|
| 2 | Is SIF_Error present? |
If yes, go to Step 14. |
| 3 | Is SIF_Status/SIF_Code 1 (immediate SIF_Ack)? |
If no, go to Step 5. |
| 4 | If no message matches SIF_OriginalMsgId, set SIF_Error/SIF_Category
to 12 (Generic Message Handling) and SIF_Error/SIF_Code to 6
(no such message). Otherwise remove the identified message from the Agent's queue and set SIF_Status/SIF_Code
to 0. |
Return SIF_Ack. Message handling complete. |
| 5 | Is SIF_Status/SIF_Code 2 (intermediate SIF_Ack)? |
If no, go to Step 7. |
| 6 | If no message matches SIF_OriginalMsgId, set SIF_Error/SIF_Category
to 12 (Generic Message Handling) and SIF_Error/SIF_Code to 6
(no such message). If the message identified is not a SIF_Event, set SIF_Category
to 13 (SMB Error) and SIF_Code to 2 (SMB can only be invoked
on a SIF_Event). Otherwise invoke SMB on the identified SIF_Event, persisting
SIF_OriginalMsgId, and set SIF_Status/SIF_Code
to 0. This event is blocked and all SIF_Events are frozen. |
Return SIF_Ack. Message handling complete. |
| 7 | Is SIF_Status/SIF_Code 3 (final SIF_Ack)? |
If no, go to Step 9. |
| 8 | If SMB has not been invoked or the message identified by SIF_OriginalMsgId doesn't
exist or doesn't match the SIF_Event blocked by SMB, set SIF_Error/SIF_Category
to 13 (SMB Error) and SIF_Error/SIF_Code to 4
(incorrect SIF_MsgId in final SIF_Ack). (In the case of SMB having been invoked but the
message not matching, end SMB, remove the message blocked by SMB from the Agent's queue and unfreeze
delivery of events.) Otherwise end SMB, remove the identified message from the Agent's
queue and unfreeze delivery of events. Set SIF_Status/SIF_Code
to 0. |
Return SIF_Ack. Message handling complete. |
| 9 | Is SIF_Status/SIF_Code 7 (already have this SIF_MsgId from you)? |
If no, go to Step 11. |
| 10 | The ZIS cannot correct this, as the SIF_MsgId
originates from an Agent and can't be changed without other repercussions. Remove the message from
the Agent's queue. Set SIF_Status/SIF_Code to 0. |
Return SIF_Ack. Message handling complete. |
| 11 | Is SIF_Status/SIF_Code 8 (receiver is sleeping)? |
If no, go to Step 13. |
| 12 | The Agent is stating it cannot process the message at this time; leave it as the next message to be delivered. Set SIF_Status/SIF_Code to 0. |
Return SIF_Ack. Message handling complete. |
| 13 |
The Agent has violated protocol.
Indicate |
Return SIF_Ack. Message handling complete. |
| 14 |
The Agent has indicated a SIF_Error
condition. See Error Codes with
SIF_Category and SIF_Code, and examine SIF_Desc and SIF_ExtendedDesc,
if included. If SIF_Category does not indicate a transport error, remove the message from the Agent's
queue. Otherwise it remains the next message to be delivered. Set SIF_Status/SIF_Code
to 0. |
Return SIF_Ack. Message handling complete. |