Cisco Cisco Prime Collaboration 10.6 User Guide

Page 21 of 78

Prime Collaboration Provisioning NBI Requests

All requests will synchronously return a CupmApiResponseValue object or throw an exception. Exceptions thrown

are generated by WSDL/XSD or by the NbiManager.

All NBI requests will asynchronously return a CupmApiList object. The first element of the CupmApiList is an

CupmApiStatus object. The second element is the requested return data, if any.

Request Signature Class

The Prime Collaboration Provisioning NBI is formally defined in the WSDL and XSD files. Each NBI request has a

natural Java signature. The request can be coded as a Java class method call. The peer child objects in the

request object become Java parameters to the method.

The RequestSignature class, provided in the SDK, defines this Java request signature interface. The

CUPMServiceStub stub is always required as the first argument, to connect to the server. Utility commands to

generate this stub are also provided in this class. This class also provides a subclass for returning data. Both the

initial response document and the extracted CupmApiResultValue (when applicable) are returned.

There are some consistent changes in the Java signatures that differ from the XSD signatures. This makes the

requests easier to generate in the Java environment.

Following are the consistent signature changes:

• EPR is passed in as a string. The RequestSignature class will convert the string to an EPR object

containing an Address object for you.

• Enumeration values are passed in as strings.

• Provides a ResponseReturn class that returns both the original response document and the attached

CupmApiResultValue.

The following sections specify the Java signature for each request, as it is defined in the RequestSignature class.

Device Management Commands and Queries

The Prime Collaboration Provisioning NBI supports full management of the Prime Collaboration Provisioning

Device object.

createDevice Java Signature

Creates a new device.

Syntax:

public ResponseReturn createDevice (CUPMServiceStub stub, DeviceValue device, String endPointReference,

String idPrefix);

Parameters:

• device—Device object with attribute keys and attribute name-value pairs set to their initial value.