Cisco Cisco Prime Collaboration 10.5 User Guide

 

 

© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 

Page 51 of 78 

 

Check Connectivity Request 

ping Java Signature 

Syntax: 

public ResponseReturn ping (CUPMServiceStub stub, String epr) 

Returns: 

Two strings, the Prime Collaboration Provisioning version and the Prime Collaboration Provisioning NBI version. 

AsyncReturn: 

A test string containing server status is sent to the specified notification consumer at the EPR provided. 

Inventory Queries 

getInventoryItem Java Signature 

Retrieves an inventory item. The getInventoryItem request requires only the attributes necessary to select a unique 

instance. Including nonkey attributes in this request is not an error, but it is not recommended as nonmatching 

values or incorrect attribute names will cause a failure. 

Syntax: 

public ResponseReturn getInventoryItem (CUPMServiceStub stub, InventoryItemValue item, String 

endPointReference, String idPrefix); 

Parameters: 

•  item—An InventoryItem object that specifies the object type to retrieve, and the attribute keys and unique 

values for those keys. 

•  endPointReference—String to convert to an EndpointReference object that the asynchronous result 

notification will be sent to. 

•  idPrefix—String that is added to the beginning of the internally generated numeric to form the unique NBI 

identifier. A null or empty string is valid, resulting in an NBI identifier that is just the internally generated 

numeric. 

Returns: 

CupmApiResponseValue—Object with NBI ID. 

Throws: 

GetInventoryItemException—If server cannot execute NBI request.