Provides "raw" access to the SCOPIA Management XML API so that a service writer can submit requests directly to SCOPIA Management using
XML. The XML interface is documented in
Reference Guide for SCOPIA Management XML API Version 8.0.
SCOPIA supports a rich set of capabilities through its XML API, and a service writer can use this class to leverage a substantial portion
of those capabilities beyond the functionality present in the other classes that are part of the Avaya Breeze
Scheduled Conference API. Please note that this interface does not support all possible operations that are available when interfacing
directly with Scopia through its XML interface. In general, operations that consist of a single request to Scopia followed by a single
response from Scopia are supported. This means, for example, that there is no provision available here to register for Scopia events and
then receive notifications of events as they are generated. It is also possible that certain Scopia operations may exist that consist of
a single request/single response but do not behave as expected when invoked through this interface.
Not surprisingly, use of this class imposes additional burdens on the service writer in the form of marshalling and unmarshalling XML.
The example below illustrates an XML request that will schedule a conference:
<MCU_XML_API>
<Request>
<Schedule_Conference_Request>
<RequestID>1700541069</RequestID>
<Conference>
<AccessPIN>NzkzMjk=</AccessPIN>
<ModeratorPIN>OTI5NDU=</ModeratorPIN>
<ServicePrefix>82</ServicePrefix>
<Number>8224936</Number>
<ReservedPorts><Regular>2</Regular></ReservedPorts>
<Subject>Conference Subject</Subject>
<Description>This is a description for the conference</Description>
<StartTime>2013-06-20T11:14:06+00:00</StartTime>
<Duration>PT30M</Duration>
</Conference>
</Schedule_Conference_Request>
</Request>
</MCU_XML_API>
Please note the following items regarding the example:
-
Unless noted otherwise, all fields (or XML tags) are required.
-
The RequestID is an arbitrary number used to correlate requests with responses. Since this ScopiaRequest class already
synchronizes requests and responses for you, the correlation capability provided by this number is redundant. However, to assure proper
behavior, it is recommended that each request you send contains a randomly generated RequestID, as required by the SCOPIA
Management XML API.
-
Neither the AccessPIN nor ModeratorPIN are required. If they are present in the request, they must be passed to SCOPIA
Management encoded in Base64. The pin values shown above represent an unencoded AccessPIN value of 79329 and
ModeratorPIN of 92945.
-
The ServicePrefix value must match the service prefix for a Meeting Type configured in Scopia Mangement.
-
The Number value consists of the ServicePrefix (see previous item) followed by a random integer. The Number
identifies a conference and is used to join a conference. It must not already exist in SCOPIA Management as a current or future meeting.
-
The Description and ReservedPorts fields are optional.
For more information, please refer to the
Reference Guide for Scopia Management XML API Version 8.0.
Important session bean information is described in the description of the
com.avaya.collaboration.conference.scheduled package.
This class is not thread-safe.