Installing the Plug-In Development Environment

Most of the pieces that you need to create a plug-in solution are part of the standard Sun N1 Service Provisioning System software. However, you must install a few additional software ingredients to provide you with a complete development solution. These key pieces are contained in the /plugins/lib/sps-compSDK.jar and the /plugins/lib/plugin-core.jar files on the Sun N1 Service Provisioning System 5.2 DVD.

sps-compSDK.jar File

The sps-compSDK.jar contains the N1 SPS public Java API

Install the sps-compSDK.jar file on your development system, not on your N1 SPS Master Server. Once you place the sps-compSDK.jar file where you want, be sure to modify the classpath for your Java tools to find the file.

The sps-compSDK.jar file contains the following Java classes for creating plug-ins. For detailed explanations of the classes and interfaces in these packages, see Sun N1 Service Provisioning System 5.2 JavaDoc.

com.sun.n1.sps.client

Includes classes and interfaces to execute CLI commands and query information from the Master Server

com.sun.n1.sps.model

Includes classes and interfaces to identify the version number, visibility, and ID of N1 SPS objects

com.sun.n1.sps.model.category

Includes three interfaces to group related objects, such as components and plans, in categories

com.sun.n1.sps.model.component

Includes interfaces and classes for defining component information

com.sun.n1.sps.model.difference

Includes interfaces and classes for defining provisioning comparisons

com.sun.n1.sps.model.executor

Includes interfaces and classes for running plans and native OS commands

com.sun.n1.sps.model.folder

Includes interfaces for defining N1 SPS folders

com.sun.n1.sps.model.host

Includes interfaces and classes for defining host criteria, including host sets, host IDs, host searches, applications running on specific hosts, and upgrade activities for specific hosts.

com.sun.n1.sps.model.install

Includes interfaces for gathering information about components that are installed on target hosts

com.sun.n1.sps.model.plan

Includes interfaces and classes for running N1 SPS plans

Package com.sun.n1.sps.model.plugin

Includes interfaces for defining plug-ins and enabling other users to browse these plug-in in the browser interface

com.sun.n1.sps.model.resource

Includes an interface for defining a resource

com.sun.n1.sps.model.rule

Includes interfaces and classes that you can use to define criteria and rules for specific actions

com.sun.n1.sps.model.user

Includes interfaces and classes that you can use to set user and group permissions, IDs, and variables

com.sun.n1.sps.model.util

Includes interfaces, classes, and exceptions that you can use to perform basic network connectivity validation, through ping and traceroute

com.sun.n1.util.collections

Includes interfaces for defining lists and sets

com.sun.n1.util.enum

Includes interfaces, classes, and exceptions for enumerations and enumerations types

com.sun.n1.util.vars

Includes one interface that you can use to identify the source of variable settings

plugin-core.jar File

The plugin-core.jar contains three packages that provide file system-based component browse and export classes:

com.sun.n1.sps.pluginimpl.system

Includes several constants that identify supported platforms

com.sun.n1.sps.pluginimpl.system.browse

Includes five classes that you can use to support file system-based browsing functionality:

• FileDisplay – A display appropriate for file system files

• FilesystemBrowser – A hierarchy browser for files ystems

• FilesystemBrowserFactory – Factory to return types sufficient for browsing a file system as a hierarchy

• FilesystemExtensionFilter – A FilesystemFilter that filters based on the file extension suffix

• FilesystemFilter – Base class for all file system filters

com.sun.n1.sps.pluginimpl.system.export

Provides one class FilesystemExporter that you can use to export a simple filesystem object