Cisco Cisco Prime Collaboration 10.6 开发者指南

下载
页码 82
 
 
© 2012 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
Page 33 of 82 
Synchronization NBI requests perform the same operations as those done using the Prime Collaboration 
Provisioning user interface. 
A synchronization status is returned, consisting of a CupmApiList with three string elements: a start time, an end 
time, and a message. 
syncDevice Java Signature 
Synchronizes the Prime Collaboration Provisioning database by polling the specified managed device. Specify a 
device capability to synchronize. Specify synchronization of the device infrastructure, the subscribers configured on 
the device, or both. 
Syntax
public ResponseReturn syncDevice (CUPMServiceStub stub, DeviceValue device, SyncType syncType, 
ExecuteOption executeOption, String endPointReference, String idPrefix); 
Parameters
 
device
—The device to synchronize; only the key attribute DeviceName is required. The Capability 
attribute in the Device object can be used to specify which capacities to synchronize for devices that have 
multiple capabilities. 
 
syncType
—An Enum, indicating which of the two synchronizations to perform, or both. Values are INFRA, 
SUBSCRIBER, BOTH (default). 
 
executeOption
—An Enum, indicating whether to perform the synchronization or whether to return the 
status summary of the last synchronization. Values are SYNC or LAST_SYNC_STATUS. 
 
endPointReference
—String to convert to an EndpointReference object that the asynchronous result 
notification will be sent to. 
 
idPrefix
—String added to the beginning of a numeric string generated by the server that is set to the value 
of the NBI ID. Null is allowed. 
Returns
CupmApiResponseValue
—Object with NBI ID. 
Throws
SyncDeviceException
—If server cannot execute NBI request. 
ASyncReturn
 
CupmApiResultValue
—Contains the CupmApiStatus and an CupmApiList. The CupmApiList contains one 
or two CupmApiList objects, each in the synchronization status format. When two are present, the first is 
for Infrastructure synchronization status, and the second is for Subscriber synchronization status. 
 
CupmApiFaultType
—Included if the NBI request fails. 
syncDomain Java Signature 
Performs a Prime Collaboration Provisioning synchronization of a Domain with its devices.