Hi folks, Wednesday (28 September 2005)
Below are definitions for the two new WIMS operations in the optional
WIMS Manager Interface to complete the symmetry of the WIMS Protocol.
Comments?
Cheers,
- Ira
Ira McDonald (Musician / Software Architect)
Blue Roof Music / High North Inc
PO Box 221 Grand Marais, MI 49839
phone: +1-906-494-2434
email: imcdonald at sharplabs.com
------------------------------------------------------------------------
[insert before section 6.2.1, renumbering SetSchedule/Execute Action]
6.2.1. BeginManagement
BeginManagement (managerURI : URI
agentReference : AgentReference,
operations : WIMSOperationsSupported,
actions : WIMSActionsSupported,
objects : WIMSObjectsSupported,
schedule : Schedule)
statusString : StatusString,
operations : WIMSOperationsSupported,
actions : WIMSActionsSupported,
objects : WIMSObjectsSupported)
Description:
WIMS Manager sends a request to create a management association with the
target WIMS Agent. That is, the target WIMS Agent will now be managed
by the source WIMS Manager. WIMS Manager also identifies the specific
operations, objects and actions it supports (but which may or may not be
supported in the WIMS Agent) and sends an initial Schedule. WIMS Agent
returns the operations, objects, and actions it supports. The WIMS
Agent will subsequently perform the actions identified in the supplied
Schedule.
Parameters:
managerURI : URI
URI of the source WIMS Manager that initiated this operation. This
value MUST use the 'pwg-wims:' URI scheme (see section 'WIMS URI
Scheme').
agentReference : AgentReference
Reference to the target WIMS Agent to be managed. This value MAY use
the 'pwg-wims:' URI scheme (see section 'WIMS URI Scheme') or it MAY be
an enterprise-specific name, asset number, etc., to protect the privacy
of the enterprise network.
operations : WIMSOperationsSupported
List of WIMS protocol operations supported by this WIMS Manager.
actions : WIMSActionsSupported
List of WIMS protocol actions supported by this WIMS Manager.
objects : WIMSObjectsSupported
List of objects supported by this WIMS Manager.
schedule : Schedule
A set of planned actions and their timetables. This Schedule Instance
MUST conform to the XML Schema defined in the PWG Semantic Model
[PWG5105.1] module 'Schedule.xsd'.
Returns:
statusString : StatusString
A keyword, returned by the Agent reflecting its status with respect to
the operation, at the time of the response. Conforms to definition in
the Semantic Model [PWG5105.1] module 'PwgCommon.xsd'.
operations : WIMSOperationsSupported
List of WIMS protocol operations supported by this WIMS Agent. This
list should be a subset of the operations listed in the BeginManagement
request.
actions : WIMSActionsSupported
List of WIMS protocol actions supported by this WIMS Agent. This list
should be a subset of the actions listed in the BeginManagement request.
objects : WIMSObjectsSupported
List of objects supported by this WIMS Agent. This list should be a
subset of the objects listed in the BeginManagement request.
Example:
BeginManagement (managerURI : URI
agentReference : AgentReference,
operations : WIMSOperationsSupported,
actions : WIMSActionsSupported,
objects : WIMSObjectsSupported,
schedule : Schedule)
BeginManagementResponse (statusString : StatusString,
operations : WIMSOperationsSupported,
actions : WIMSActionsSupported,
objects : WIMSObjectsSupported)
Method Support:
WIMS Agent - OPTIONAL to support
WIMS Manager - OPTIONAL to support
6.2.2. EndManagement
EndManagement (managerURI : URI,
agentReference : agentReference)
statusString : StatusString
Description:
WIMS Manager sends a request to cancel a management association with
the target WIMS Agent. That is, the target WIMS Agent will no longer be
managed by the source WIMS Manager.
Parameters:
managerURI : URI
URI of the source WIMS Manager that initiated this operation. This
value MUST use the 'pwg-wims:' URI scheme (see section 'WIMS URI
Scheme').
agentReference : AgentReference
Reference to the target WIMS Agent to be managed. This value MAY use
the 'pwg-wims:' URI scheme (see section 'WIMS URI Scheme') or it MAY be
an enterprise-specific name, asset number, etc., to protect the privacy
of the enterprise network.
Returns:
statusString : StatusString
A keyword, returned by the Agent reflecting its status with respect to
the operation, at the time of the response. Conforms to definition in
the Semantic Model [PWG5105.1] module 'PwgCommon.xsd'.
Example:
EndManagement (managerURI : URI
agentReference : AgentReference)
EndManagementResponse (statusString : StatusString)
Method Support:
WIMS Agent - OPTIONAL to support
WIMS Manager - OPTIONAL to support
------------------------------------------------------------------------