- 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 Per-Product Services
Per-Product Services are additional, value-added services that individual products can choose to include based on their particular requirements. Installations of Per-Product Services are normally not shared among the applications installed on a single server.
The following topics discuss the CWCS Per-Product Services and and the components you need to include to use them as part of your applications:
•
Understanding Per-Product Services
•About the Per-Product Services Components
Understanding Per-Product Services
The Per-Product Services discussed in this section are always installed and run by individual applications. They form a set of advanced services that add value to applications by either meeting requirements for advanced functions in CiscoWorks applications, or allowing for variation in how these features are implemented. Table 29-1 summarizes these feature requirements and the corresponding Per-Product Services designed to meet them.
Note that some Per-Product components (such as UII) are also used in the CWCS-R distribution. This is done to support certain Shared Services. Note that these CWCS-R-distributed Per-Product components are for CWCS use only. Applications may not share Per-Product components installed with CWCS-R. Application teams must install their own copies of Per-Product components with their applications, and they may not modify the source of or substitute products intended to perform the same functions as any Per-Product component distributed with CWCS-R.
As noted in the table, many Per-Product components are provided as part of the CWCS-SRC distribution. Application teams may modify CWCS-SRC-distributed Per-Product components for their own requirements, and install them with their applications. Note that it is a requirement of CWCS-SRC distribution that application teams who modify a CWCS-SRC component's source are responsible for providing their own support on these components. Application teams must also provide fully commented copies of their modified source to the CWCS Team.
Per-Product Services often represent the future direction of Common Services. Where possible, you should plan your application to adopt them as standard. For example: the CiscoWorks Home Page, which provides GUI access to applications, has been adopted as the standard GUI, entirely replacing the old CMF Desktop.
|
|
|
|
|
|
|---|---|---|---|---|
Graphic User Interface |
User Interface Support |
Support a web-based launch point that aggregates all applications. |
CWCS-SRC |
The launch point is provided by the CiscoWorks Home Page (see the "About the CiscoWorks Home Page Component" section on page 6-5), which in turn requires the User Interface Infrastructure (UII). See the "About the User Interface Infrastructure" section. |
Device Selector |
Let users see and select devices and groups of objects |
CWCS-SRC |
Part of the UII; comes in several different forms. See the "About the User Interface Infrastructure" section. |
|
Graphing Service |
Allow GUI display of graphs from user data. |
CWCS-SRC |
A Graphing Framework is provided as part of the UII. See the "About the User Interface Infrastructure" section. |
|
Group Management |
Let users or administrators create and maintain groups of objects (e.g., devices or user IDs). |
CWCS-SRC |
See the "About the Object Grouping Service (OGS) Components" section. |
|
Operations |
Device Package Update |
Support delivery of incremental device packages. |
CWCS-R |
Provided by PSU with VDS. See the "About the Package Support Updater (PSU) Components" section |
Incremental Device Support |
Permit incremental device support. |
CWCS-SRC |
Provided by the CIDS package. See the "About the Common Incremental Device Support (CIDS) Component" section |
|
IPC/RPC Support |
Provide support for Inter-Process Communications (IPC), In-Process Calls, and Remote Procedure Calls (RPC) |
CWCS-SRC |
CSTM provides full IPC/RPC support. See the "About the Common Services Transport Mechanism (CSTM) Components" section. |
|
Licensing |
Provide flexible management of licenses, including multiple keys. |
CWCS-R |
See the "About CWCS Licensing" section. |
|
SOAP Support |
Support SOAP encoding. |
CWCS-SRC |
CSTM uses SOAP internally and exposes northbound APIs in a SOAP-based format. See "About the Common Services Transport Mechanism (CSTM) Components" section |
|
Virtual Download Service |
Download and install incremental device packages. |
CWCS-R |
Provided by PSU with VDS. See the "About the Package Support Updater (PSU) Components" section |
|
Utilities |
DOM Parser |
Provide Document Object Model parser support for Core, MC and Kilner applications |
CWCS-R |
JDOM 1.0 Beta 8 is supported. See the "" section. |
Email Support |
Provide utilities that support email generation |
CWCS-R |
Utilities provided include JavaMail 1.2 and Blat for Windows NT. Solaris email is used on Solaris platforms. See the "" section. |
|
JRE Support |
Support multiple versions of the Java Runtime Environment. |
CWCS-R |
JRE versions 1.2.2, 1.3.1, and 1.4 are supported. See the "" section. |
|
Logging Service |
Provide utilities that support creation and management of application logs. |
CWCS-R |
Utilities provided include Log4J 1.1.3, coreLog4c, CoreLogger, CMF logging, and JGL 3.1. See the "" section. |
|
SNMP Library |
Support SNMP calls from Java applications. |
CWCS-SRC |
The latest version of the SNMPOnJava library supports SNMPv3. See the "" section. |
|
XML Parser |
Support a variety of XML parsers. |
CWCS-R |
Libraries provided include standard Xerces Java 1.4.3 and 1.4.4 library, JAXP, Crimson, Xerces C++ 1.5.1, and IBM4J. See the "" section. |
|
XSLT Support |
Support a variety of XML Stylesheet processors. |
CWCS-R |
Libraries provided include LotusXSL 0.16.3, Xalan Java 2.2.d9, Xalan C++ 1.5.1, and Xalan 2.4.1. See the "" section. |
About the Per-Product Services Components
The following topics provide basic information for each of the Per-Product Service components:
•About the Object Grouping Service (OGS) Components
•About the Common Services Transport Mechanism (CSTM) Components
•About the Package Support Updater (PSU) Components
•About the Common Incremental Device Support (CIDS) Component
•About the User Interface Infrastructure
Each topic includes:
•Basic information about the component's purpose and features.
•Usage guidelines. Where these guidelines require a separate chapter in this Guide, a pointer to that chapter is supplied.
•Pointers to Java, C++, Perl or other references and code samples supplied as part of the SDK.
•The names of the packages on which the component depends.
•Where they exist: The names of utilities that help you troubleshoot or use the component.
For the same information for Shared Services, see Chapter 6, "Using Shared Services".
About the Object Grouping Service (OGS) Components
The Object Grouping Service provides a generic framework for creating, managing, and sharing hierarchical groups of objects. These objects can be any type of data object, from network devices to user IDs, capable of being grouped based on shared attributes . The OGS framework provides tools to define groups useful to your application, and to supply them in predefined form with your application.
For guidelines to follow when including OGS with your application, see Chapter 30, "Using Object Grouping Services". OGS is functionally dependent on the packages shown in Table 29-2.
About the Common Services Transport Mechanism (CSTM) Components
CSTM (formerly Common Transport Mechanism, or CTM) is a a simple, platform-agnostic method for performing all types of inter-program communications. It does not require that sender or receiver applications implement proprietary standards like CORBA or DCOM, use the same object model, have full knowledge of message contexts, or avoid encoding metadata. Instead, it abstracts these communications, provides a single API for dealing with all of them, and bases the API on well-known non-proprietary communications and data standards, including XML, Serialized Java Objects, HTTP, sockets, and standard binary and SOAP encoding.
For guidelines to follow when including CSTM with your application, see Chapter 31, "Using the Common Services Transport Mechanism". CSTM is functionally dependent on the packages shown in Table 29-3,
About the Package Support Updater (PSU) Components
The PSU (and associated Virtual Download Service, or VDS) allows your application to:
•Check for software and device support updates.
•Download these updates and related dependent packages to the application's server file system.
•Install them.
For guidelines to follow when including PSU/VDS with your application, see Chapter 32, "Using Package Support Updater". PSU is functionally dependent on the packages shown in Table 29-4.
|
|
|
|---|---|
CSCOweb/web |
Web Services: Apache, OpenSSL, ModSSL |
PSU/VDS |
Package Support Updater/Virtual Download Service |
About the Common Incremental Device Support (CIDS) Component
Common Incremental Device Support (CIDS) provides a method of adding device information to any network management application without requiring re-installation of the entire product. CIDS provides an application layer that encapsulates all device information and update mechanisms, permitting applications that include a CIDS layer to be incrementally updatable for new instances of existing devices, as well as new types of devices.
For guidelines to follow when including CIDS with your application, see Chapter 33, "Using Common Incremental Device Support". CIDS is functionally dependent on the packages shown in Table 29-5.
About CWCS Licensing
The CWCS Licensing API allows your application to:
•Install and update licenses
•Create, manage, retrieve and restore license information
•Access FLEXlm license utilities.
The API supports:
•Evaluation-onlylicensing
•Full-purchase licenses.
•Resource-limited licenses, which specify (for example) the number of devices an application can manage.
•Feature licenses, which grant the right to use features within an application.
•Temporary use of a PIN to validate use of a feature.
The API does not explicity support other kinds of license models, such as node-locked licenses, floating licenses, and counted licenses. However, the API provides access to the FLEXlm toolkit for applications that must implement a licensing model with these kinds of special requirements.
The API provides:
•A repository to store PINs and PAKs.
•An API to install licenses and to retrieve license information, including PIN/PAK.
•A license administration GUI.
•The FLEXlm license toolkit.
•A license backup and restore function.
For guidelines to follow when including the Licensing API with your application, see Chapter 34, "Using the Licensing APIs". The Licensing API is functionally dependent on the packages shown in Table 29-6.
About the User Interface Infrastructure
The User Interface Infrastructure (UII) is a web-application framework for creating application GUIs that conform to Cisco's User Experience Initiative (UE) guidelines (available at http://picasso). Based on the Apache/Jakarta STRUTS framework, the UII provides:
•A complete set of tools for creating displays, dialogs, tables, lists, wizards, buttons and icons.
•A Reporting Framework that allows you to create and display all types of reports as web pages.
•A Graph Framework that allows you to create and display line, pie, bar, stacked bar, and area graphs.
The UII is not documented in this Guide. Guidelines for using these tools and implementing a UII-compliant GUI are provided in the SDK Developer's Guide for UI Infrastructure (release 6.1 or later). This document is available
–As a PDF file within the SDK WAR file, or within EDCS (Release 6.1 of the Guide is available as EDCS-275335). You can use the PDF to print a hardcopy version.
–As HTML-based online help. The HTML version is available from the User Experience web site at http://picasso. Select Technology > UII Releases.
The UII is functionally dependent on the packages shown in Table 29-7. For a working model of the UII, see http://uii.cisco.com.
Feedback