Cisco Cisco Prime Collaboration Provisioning 11.2 Developer's Guide

Page 34 of 82

Syntax:

public ResponseReturn syncDomain (CUPMServiceStub stub, DomainValue Domain, ExecuteOption

executeOption, String endPointReference, String idPrefix);

Parameters:



Domain

—The key attribute, DomainID is required.



ExecuteOption

—An Enum, indicating whether to perform the synchronization or whether to returnthe

status summary of the last synchronization. Values are SYNC or LAST_SYNC_STATUS. The

LAST_SYNC_STATUS option does not do the synchronization, but returns the status from the last

synchronization.



endPointReference

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

notification will be sent to.



idPrefix

—Precedes the NBI ID returned to the client.

Returns:

CupmApiResponseValue

—Object with NBI ID.

Throws:

SyncDomainException

—If the server cannot execute the NBI request.

ASyncReturn:

 CupmApiResultValue—Contains the CupmApiStatus and a CupmApiList. The CupmApiList contains a

CupmApiList object in the synchronization status format.

 CupmApiFaultType—Included if the NBI request fails.

Note: A syncDomain command will be rejected by the server if any of the devices that belong to the Domain are

running a synchronization.

Subscriber Management Commands and Queries

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

object. It also supports some specialized commands for querying configured subscriber services and resetting

passwords.

createSubscriber Java Signature

Creates one subscriber.

Syntax:

public ResponseReturn createSubscriber (CUPMServiceStub stub, SubscriberValue subscriber, String

endPointReference, String idPrefix);

Parameters:



subscriber

—Subscriber object with attribute keys and attribute name-value pairs set to their initial value.