- Introducing CWCS
- FAQs and Programming Hints
- Understanding the CWCS Directory Structure
- Understanding the CWCS Execution Environment
- Getting Started with CWCS
- Using Shared Services
- Using the CiscoWorks Home Page
- Using Web Servers and Servlet Engines
- Integrating Applications with CMIC
- Using the Security System
- Using the Database APIs
- Using Backup and Restore
- Using the Core Client Registry
- Using the Device Credentials Repository
- Using the Core Logging API
- Adding Online Help
- Using the Daemon Manager
- Using the Job and Resource Manager
- Using Event Services Software
- Using the Event Distribution System
- Using the Installation Framework
- Using the Java Plug-in
- Using the Diagnostic and Support Utilities
- Using SNMP Services
- Using NT Services
- Using Device Center
- Using Product Instance Device Mapping
- Integrating Applications with Device Selector
- Using Per-Product Services
- Using Object Grouping Services
- Using the Common Services Transport Mechanism
- Using Package Support Updater
- Using Common Incremental Device Support
- Using the Licensing APIs
- Glossary
Using Product Instance Device Mapping
Product Instance Device Mapping (PIDM) is a registry that stores mapping information between devices and applications.
Applications need to register with PIDM the information about the devices managed by the applications. Applications can do this using PIDM APIs (which are also available via CSTM from Common Services 3.0 Service Pack 2).
Device Center depends on this information for showing the devices in Device Selector and also for showing the information under Tools , Management Tasks , Reports and Summary sections.
Device Center usually shows only the devices managed by the applications in the Device Selector. On selecting a device, the links corresponding to the applications that manage the device are shown in Device Center.
The following topics describe how to integrate DCR with your application:
•
Using the PIDM North-bound APIs
Using the PIDM APIs
The PIDM APIs are as follows:
Creating the ProductToDeviceMapProxy Object
ProductToDeviceMapProxy pidm = new ProductToDeviceMapProxy();
Mapping a Device or Marking a Device(s) as Managed
DeviceId devId = new DeviceId("101");
AppId Myapp = new AppId("Campus Manager","4.0","bundle-pc10");
try {
pidm.mapDeviceToProduct(Myapp, devId);
catch (PDMException pdmExp) {
System.out.println("Error in mapping a Device " + pdmExp.getMessage());
Unmapping a Device or Marking a Device(s) as Not Managed
DeviceId devId = new DeviceId("101");
AppId Myapp = new AppId("Campus Manager","4.0","bundle-pc10");
try {
pidm.unmapDeviceToProduct(Myapp, devId);
catch (PDMException pdmExp) {
System.out.println("Error in un-mapping a Device " + pdmExp.getMessage());
}
Retrieving PIDM Information
To get the applications managing a particular device:
DeviceId devId = new DeviceId("101");
AppId appIds[] = pdm.getMappedAppIDs(devId);
To get devices managed by a particular application.
DeviceId devIds[] = pdm.getMappedDeviceIDs(Myapp);
Using the PIDM North-bound APIs
PIDM APIs are also available via CSTM from Common Services 3.0 Service Pack 2.
PIDM North-bound APIs
The PIDM North-bound APIs are as follows:
PIDM NBAPIs and Associated Tasks
The PIDM NBAPIs and associated tasks are as follows:
Creating the APIExtraInfo Object
ProductToDeviceMapNBProxy API accepts objects of class APIExtraInfo in addition to their regular arguments. APIExtraInfo encapsulates:
•The AppID - This object is the unique ID of your application, and establishes your application name, version number, and host information for use in the SourceContext object.
•The SourceContext - This object establishes your application and its context as the source of the ProductToDeviceMapNBProxy API call.
•The SecurityContext - This object contains the information needed to authenticate or authorize the ProductToDeviceMapNBProxy API request.
AppId Myapp = new AppId("Device Manager", //unique AppID and application name
"1.3.2", //application version number
"192.168.1.15"); // host on which the application is running
SourceContext source = new SourceContext(Myapp) ;
// For Local API calls
SecurityContext security = new SecurityContext("username");
// For North-Bound API calls
SecurityContext security = new SecurityContext("username",
"password",
"secretKey")
//Wrapper for Source and Security information:
APIExtraInfo extraInfo = new APIExtraInfo(security, source);
Creating the ProductToDeviceMapNBProxy Object
ProductToDeviceMapNBProxy pidmNB = new ProductToDeviceMapNBProxy();
Mapping a Device or Marking a Device(s) as Managed
DeviceId devId = new DeviceId("101");
AppId Myapp = new AppId("Campus Manager","4.0","bundle-pc10");
try {
pidmNB.mapDeviceToProduct(Myapp, devId, extraInfo);
}
catch (PDMException pdmExp) {
System.out.println("Error in mapping a Device " + pdmExp.getMessage());
}
Unmapping a Device or Marking a Device(s) as Not Managed
DeviceId devId = new DeviceId("101");
AppId Myapp = new AppId("Campus Manager","4.0","bundle-pc10");
try {
pidmNB.unmapDeviceToProduct(Myapp, devId, extraInfo);
}
catch (PDMException pdmExp) {
System.out.println("Error in un-mapping a Device " + pdmExp.getMessage());
}
Retrieving PIDM Information
To get the applications managing a particular device:
DeviceId devId = new DeviceId("101");
AppId appIds[] = pidmNB.getMappedAppIDs(devId, extraInfo);
To get devices managed by a particular application.
DeviceId devIds[] = pidmNB.getMappedDeviceIDs(Myapp, extraInfo);
Feedback