com.sun.n1.sps.model.plugin
Interface Plugin

public interface Plugin

Plugins are first class objects that represent a bundled set of system objects, as well as other data. System objects that are children of plugins are:

• components
• component types
• plans
• folders
• host sets
• host searches
• host types
• system services

Other data associated with a plugin include:

• the certificate used to sign the plugin
• the UI descriptor
• Master Server jar

Method Summary

java.security.cert.Certificate	getCertificate() Returns the certificate used to sign the plugin.
java.lang.String	getCertificateText() Returns the a string representation of the certificate used to sign the plugin.
ComponentIDSet	getComponents() Returns the a list of components owned by this plugin.
ComponentTypeRefIDSet	getComponentTypes() Returns the a list of component types owned by this plugin.
java.lang.String	getCustomPagePath() Returns the path to the transformed UI descriptor included in the plugin.
PluginIDSet	getDependencies() Returns a list of plugins on which this plugin depends.
java.lang.String	getDescription() Returns the description of this object.
FolderIDSet	getFolders() Returns the a list of folders owned by this plugin.
HostSearchIDSet	getHostSearches() Returns the a list of host searches owned by this plugin.
HostSetIDSet	getHostSets() Returns the a list of host sets owned by this plugin.
HostTypeIDSet	getHostTypes() Returns the a list of host types owned by this plugin.
java.lang.String	getIconPath() Returns the path (on disk) to the navigation bar icon included in the plugin.
PluginID	getID() Returns the ID of this object, or null if this object.
java.lang.String	getMenuItem() Returns the menu item name associated with the plugin.
java.lang.String	getMenuOrder() Returns the menu order of this plugin.
java.lang.String	getName() Returns the name of this object.
ExecutionPlanIDSet	getPlans() Returns the a list of plans owned by this plugin.
java.lang.String	getReadMeText() Returns the contents as a String of the readme file included in the plugin.
SystemServiceRefIDSet	getSystemServices() Returns the a list of system services owned by this plugin.
java.lang.String	getVendor() Returns the vendor associated with this plugin.
VersionNumber	getVersionNumber() Returns the (user defined) version of this plugin.

Method Detail

getID

PluginID getID()

Returns the ID of this object, or null if this object. has not yet been saved.

Returns:

The ID of this object.

getVersionNumber

VersionNumber getVersionNumber()

Returns the (user defined) version of this plugin.

Returns:

The plugin version

getMenuOrder

java.lang.String getMenuOrder()

Returns the menu order of this plugin.

Returns:

The plugin menu order.

getMenuItem

java.lang.String getMenuItem()

Returns the menu item name associated with the plugin. Returns null if not present in the plugin.

Returns:

The menu item

getVendor

java.lang.String getVendor()

Returns the vendor associated with this plugin.

Returns:

The vendor name.

getReadMeText

java.lang.String getReadMeText()

Returns the contents as a String of the readme file included in the plugin. Returns null if not applicable.

Returns:

A String representation of the readme file.

getComponents

ComponentIDSet getComponents()

Returns the a list of components owned by this plugin. Returns an empty set if none exist.

Returns:

A ComponentIDSet of children components.

getPlans

ExecutionPlanIDSet getPlans()

Returns the a list of plans owned by this plugin. Returns an empty set if none exist.

Returns:

An ExecutionPlanIDSet of children plans.

getHostTypes

HostTypeIDSet getHostTypes()

Returns the a list of host types owned by this plugin. Returns an empty set if none exist.

Returns:

A HostTypeIDSet of children host types.

getHostSearches

HostSearchIDSet getHostSearches()

Returns the a list of host searches owned by this plugin. Returns an empty set if none exist.

Returns:

A HostSearchIDSet of children host searches.

getHostSets

HostSetIDSet getHostSets()

Returns the a list of host sets owned by this plugin. Returns an empty set if none exist.

Returns:

A HostSetIDSet of children host sets.

getFolders

FolderIDSet getFolders()

Returns the a list of folders owned by this plugin. Returns an empty set if none exist.

Returns:

A FolderIDSet of children folders.

getComponentTypes

ComponentTypeRefIDSet getComponentTypes()

Returns the a list of component types owned by this plugin. Returns an empty set if none exist.

Returns:

A ComponentTypeRefIDSet of children component types.

getSystemServices

SystemServiceRefIDSet getSystemServices()

Returns the a list of system services owned by this plugin. Returns an empty set if none exist.

Returns:

A SystemServiceRefIDSet of children system services.

getCustomPagePath

java.lang.String getCustomPagePath()

Returns the path to the transformed UI descriptor included in the plugin. The path uses "/" as a delimiter, and is relative to the Master Server "data" directory. Returns null if not present in the plugin.

Returns:

The path to the html page.

getCertificate

java.security.cert.Certificate getCertificate()

Returns the certificate used to sign the plugin.

Returns:

The certificate used to sign this plugin.

getIconPath

java.lang.String getIconPath()

Returns the path (on disk) to the navigation bar icon included in the plugin. The path uses "/" as a delimiter, and is relative to the Master Server "data" directory. Returns null if not present in the plugin.

Returns:

The path to the icon.

getDependencies

PluginIDSet getDependencies()

Returns a list of plugins on which this plugin depends. Returns an empty set if none exist.

Returns:

The PluginIDSet containing all dependent plugins.

getCertificateText

java.lang.String getCertificateText()

Returns the a string representation of the certificate used to sign the plugin.

Returns:

The String representation of certificate.

getName

java.lang.String getName()

Returns the name of this object.

Returns:

The name of this object.

getDescription

java.lang.String getDescription()

Returns the description of this object.

Returns:

The description of this object.