1 Overview of the Software Development Kit
This chapter provides an overview of the Oracle Communications IP Service Activator Software Development Kit (SDK) and an introduction to its tools and techniques.
About the SDK
The SDK is a toolset for creating cartridges and configuration policies to be used by the Network Processor within a IP Service Activator installation to provide a flexible and scalable device driver solution.
The structured development process inherent to the SDK combined with its robust suite of tools will enable you to achieve accurate and consistent results.
What You Can Produce Using the SDK
The SDK is used to create base cartridges, service cartridges, and configuration policies for deployment into an IP Service Activator installation.
-
Base cartridges: provide basic communications between IP Service Activator's Network Processor and its devices. A base cartridge provides the platform upon which to build service cartridges for a family of devices.
-
Service cartridges: administer specific services on a specific family of devices, the basic functionality of which is provided by a base or core cartridge. A service cartridge must be deployed as an extension to a base cartridge or a core cartridge in an IP Service Activator Network Processor installation.
-
Configuration policies: provide a GUI form and schema to collect data for services from IP Service Activator client users. In an IP Service Activator installation, configuration policies are implemented through service cartridges.
-
Configuration Management support: using the SDK, you can create and configure cartridges that support the use of services from the Configuration Management product. For details on the Configuration Management product, refer to Configuration Management Planning Guide.
Additional SDK Terms
Core cartridges are existing IP Service Activator cartridges integrated within IP Service Activator. A core cartridge combines the basic communication functionality of a base cartridge with service administration all within one package.
Vendor cartridge is a conceptual term. A vendor cartridge consists of the union of a base or core cartridge with a number of service cartridges. Thus, a vendor cartridge has the functionality to connect to a specific device type, and administer the services handled by its service cartridges.
SDK Structured Development Process
The basic process for developing cartridges and configuration policies with the SDK is as follows:
-
Create and edit a properties file.
-
Generate the cartridge source files using the provided generator tool. This generator tool is an Ant script that uses the properties in the properties file to configure a set of skeleton source files for the cartridge. This script and others are run using a command line interface.
-
Edit the generated source files to add the specific functionality for your cartridge. This is where most of your developments efforts will be spent.
-
Compile and package the cartridge using the provided Ant script.
-
Perform standalone testing using the provided scripts.
-
Deploy the cartridge into a test IP Service Activator installation and perform end-to-end testing.
Specific details to perform these steps are described in the SDK developer guides.
SDK Samples
With the SDK, you receive a number of simple, working samples. The samples are valuable to serve as examples to learn from, and to use as starting points to develop your own cartridges and configuration policies.
SDK samples include:
-
Base cartridge:
-
cisco: simple working base cartridge for Cisco IOS devices
-
-
Service cartridges:
-
ciscoBanner: implements a banner on Cisco IOS devices using XQuery transforms
-
ciscoBannerJava: implements a banner on Cisco IOS devices using Java transforms
-
ciscoStaticRoute: implements a static route on Cisco IOS devices
-
ciscoMartini: implements a Martini Layer 2 VPN site on Cisco IOS devices
-
-
Configuration policies:
-
bannerSample: implements a banner on Cisco IOS devices
-
staticrouteSample: implements a static route on Cisco IOS devices
-
Creating, deploying and testing the samples are described in the SDK developer guides.
Cartridges in Use
Figure 1-1 shows cartridges and configuration policies developed using the SDK deployed in an IP Service Activator installation. The policy server (at the top center of the diagram) is the central component of IP Service Activator. It manages the flow of data to and from its database (top left), provides GUIs for users to monitor and administer the network (top right) and through its Network Processors (lower center), it performs device discovery, runs audits, and sends configuration to devices.
As you can see, configuration policies (which provide a GUI form and schema to GUI users to collect and validate XML data for services) are implemented through service cartridges. A service cartridge is deployed as an extension to a base or core cartridge.
Figure 1-1 SDK Cartridges Deployed in an IP Service Activator Installation
Description of "Figure 1-1 SDK Cartridges Deployed in an IP Service Activator Installation"
Next Steps in Learning About the SDK
Continue reading this guide. It gives an effective description of the Network Processor, cartridges, and cartridge operation support components.
SDK Developer Guides
The developer guides in the IP Service Activator SDK documentation suite provide detailed technical explanations of how to create and configure cartridges and configuration policies. Procedures to build, package and test them are also included. Each developer guide contains detailed reference material explaining parameters, options, and the function of the various source files. Reading the following guides is recommended:
-
IP Service Activator SDK Base Cartridge Developer Guide: learn how to create base cartridges with the SDK.
-
IP Service Activator SDK Service Cartridge Developer Guide: many of the concepts learned in creating base cartridges are applicable to creating service cartridges. It is recommended you read IP Service Activator Base Cartridge Developer Guide first.
-
IP Service Activator SDK Configuration Policy Extension Developer Guide: continues to build your knowledge about the SDK by detailing how to create configuration policies, which work in conjunction with service cartridges.
-
IP Service Activator SDK Configuration Management Developer Guide: learn how to use cartridges to administer Configuration Management module services.