Cisco Cisco Configuration Engine 3.5 Developer's Guide
6-8
Cisco Configuration Engine Software Development Kit API Reference and Programmer Guide 3.5
OL-17661-02
Chapter 6 Namespace Administration, Group Administration, and Notification APIs
Namespace Administration API
List All Subjects in Namespace
This operation returns all the subjects of a given namespace.
List Selected Subjects in a Namespace
This operation returns selected subjects of a given namespace. The subjects should meet the search
criteria denoted by filter.
criteria denoted by filter.
Method
String[ ] listSubjects (String namespaceId)
Input parameter
namespaceId
This is a string that uniquely identifies a namespace.
Return
An array of Strings that lists the subjects.
Exceptions
This method could throw one of the following exceptions:
•
DatastoreAccessException – General data-store access problem that is
not described below.
not described below.
•
InvalidInputException – see
for basic rules.
•
NamespaceNotFoundException – Namespace not found
•
MessageFormatException – Problem with XML message syntax to be
sent between the server and the remote API.
sent between the server and the remote API.
Additional exceptions that could be thrown by the remote API:
CommunicationException – General server access problem.
Method
String[ ] listSubjects (String namespaceId, String filter)
Input parameter
namespaceId
This is a string that uniquely identifies a namespace.
filter
A string input which denotes a directory search filter for the listSubjects
operation. A typical input of the form “cn=S1*” will returns all subjects with
name starting with the string S1 under given namespace.
operation. A typical input of the form “cn=S1*” will returns all subjects with
name starting with the string S1 under given namespace.
Return
An array of Strings that lists the subjects.