Package com.ibm.ecm.extension
This package contains the abstract classes that you extend to build an IBM Content Navigator plug-in.
See:
Class Summary
| Class | Description |
|---|---|
| Plugin | Provides the main class of an IBM Content Navigator plug-in. |
| PluginAction | Provides an abstract class that is extended to define a client-side action that is provided by a plug-in. |
| PluginAPI | Provides an abstract class that is extended to create a class implementing an API provided by the plug-in. |
| PluginAsyncTaskType | Provides an abstract class that is extended to define an asynchronous task type provided by the plug-in. |
| PluginDocumentContent | Instances of PluginDocumentContent are returned by some of the PluginServicesCallbacks.retrieveDocumentContent to provide access to document content. |
| PluginFeature | Provides an abstract class that is extended to define a feature provided by the plug-in. |
| PluginLayout | Provides an abstract class that is extended to define a layout that is provided by a plug-in. |
| PluginLogger | |
| PluginMenu | Provides an abstract class that is extended to define a menu in a plug-in. |
| PluginMenuItem | Provides an abstract class that is extended to define a menu item that is used in a custom menu provided by a plug-in. |
| PluginMenuType | Provides an abstract class that is extended to define a custom menu type provided by a plug-in. |
| PluginODAuthenticationService | Subclass to provide a custom service used for Content Manager OnDemand single sign-on (SSO). |
| PluginOpenAction | Defines an action, which will override default action for a MIME type or MIME class. |
| PluginRepositoryConnection | This class represents a single connection to a repository provided by a plug-in. |
| PluginRepositoryType | Provides an abstract class that is extended to create a class defining a custom repository type provided by the plug-in. |
| PluginRequestFilter | Provides an abstract class that is extended to create a filter for requests to a particular service. |
| PluginRequestUtil | This class provides utility methods to use to set request parameters. |
| PluginResponseFilter | Provides an abstract class that is extended to create a filter for responses from a particular service. |
| PluginResponseUtil | This class provides utility methods to use to set request parameters. |
| PluginService | Provides an abstract class that is extended to create a class implementing each service provided by the plug-in. |
| PluginServiceCallbacks | Provides a plug-in service with access to the application programming interface (API) of the underlying server and the location of the configuration information for the plug-in. |
| PluginServiceUtil | Deprecated. since 2.0.2. |
| PluginViewerDef | Provides an abstract class that is extended to define a viewer provided by the plug-in. |
Exception Summary
| Exception | Description |
|---|---|
| PluginRepositoryLogonException | This exception is thrown by a plug-in repository to indicate various logon failures. |
Package com.ibm.ecm.extension Description
This package contains the abstract classes that you extend to build an IBM Content Navigator plug-in.
IBM Content Navigator Plug-in JAR Structure
An IBM Content Navigator plug-in is composed of a single JAR file with the following structure: packageName
Java classes for the plug-in (extending Plugin and other classes)
WebContent
images, JavaScripts, and HTML pages
WEB-INF
manifest.mf
The
packageName is one or more directories nested according to the package naming of the Java classes within the
plug-in. This structure follows the standard structure of a Java JAR file where nested folders are used for nested package names.
The classes must be contained within a named package. The default package cannot be used.
The manifest.mf file can contain the standard properties allowed for a JAR file. In addition, the following
property must be defined:
Plugin-Class: pluginClassName
where
pluginClassName is the name of the Plugin subclass for the plug-in.