Package com.novell.emframe.dev

The dev package contains classes needed for plug-in writers to write plug-ins to iManager.

See: Description

Interface Summary

Interface	Description
AsyncContext
AuthBrokerListener	Allows implementors to process login/logout events of the AuthenticationBroker.
Countable
IManagerPluginEventListener	IManagerPluginEventListener is used as a tagging interface for imanger plugin event listeners.
MContext
PluginContext	Deprecated use TaskContext
PropertyPageContext	Adds the PropertyBookPage to the Task Context for use by edas.
RuntimePlugin	If PropertyBookPage objects implement this interface, the RuntimePlugin.shouldShow(com.novell.admin.ns.NSObject, com.novell.emframe.dev.TaskContext) method is called after the user has selected the target object.
TaskContext	Passes information to Task objects.

Class Summary

Class	Description
AdvSelTypeInfo	Class returned by the AdvSelTypeInfoCallback routine which contains information necessary for the Advanced Selector widget to display the Advanced Search criterion screen.
AdvSelTypeInfoCallback	Abstract class used for a plug-in to return information to the Advanced Selector widget.
appUtils	General utility methods.
ASNOne	This class provides methods to convert a given LDAP OID string to a standard ASN1 ID sequence of bytes.
AsyncWorker
AuthBrokerAuthenticator	Abstract class to implement to be an AuthBrokerAuthenticator.
AuthBrokerEvent	Defines a Authentication Broker event.
AuthBrokerReport	This class can be used as a return from AuthBrokerAuthenticator login methods.
AuthenticationBroker	Used by iManager to manage authentication and connections to various trees or servers.
BasicCollectionAsyncWorker
Chapter	PropertyBook contain Chapters, and Chapters can contain multiple PropertyBookPage objects.
CreatorSilent	Implement this class to participate in the silent post creation of an object.
CustomTargetChooser	Abstract class to implement to become a custom target chooser for a plug-in created with the Plug-in Studio.
D	Provides a simple mechanism for plugins to log debug messages.
DataHandler	Abstract class that handles the data from a particular attribute.
DataHandlerHelper	Abstract class extended from DataHandler that handles the data from a particular attribute and contains some XML helper methods.
Deletor	Extend this class to provide a custom object deletor.
DirPropertyBook	This class is the default PropertyBook for modifying and viewing attributes of an eDirectory object.
DirPropertyBookPage	Base class used to create PropertyBookPage objects.
DirUtils	Utility methods for accessing the directory.
eDirAccessService	eDirector Access Service main task class.
eMFrameConsts	This class contains all the Parameter Names that a plugin must know about.
eMFrameFactory	Factory for creating and getting TaskContext objects.
eMFrameUtils	General utility methods for use by plug-ins.
EmptyTask	This is an implementation of Task that does nothing.
GlobalRegistry	Class used to build the Global Registry of plug-ins for iManager.
HistoryNode	Contains a node in the history list of the object target chooser.
JobData	Allows tasks who are part of a job to get and set data objects that are specific to the job.
LazyAuthBrokerAuthenticator	Abstract class to implement to be a LazyAuthBrokerAuthenticator.
ManagementServiceSet	Defines a set of services that are used within the iManager framework.
MappingObject	Class to map LDAP classes and attributes to NDAP classes and attributes and vice-versa.
Move	Extend this class to provide a custom object mover.
MTask	Abstract class to simply writing a Task to iManager.
MUtils
NPSFileAuthenticator	Deprecated
ParseFileSystemString
Plugin	Abstract class to implement to be an iManager plug-in that is not Task based.
PropertyBook	Abstract class to implement to be a Property Book.
PropertyBookPage	Base class used to create property book pages that edits an eDirectory object.
RegistryHandler	Abstract class to implement to become a Registry handler.
Rename	Extend this class to provide a custom object renamer.
SessionAttrs
TargetObjects	This class represents the targets that a task should operate on.
Task	This is the main class your Task will want to extend to plug-in to the iManager framework.
UiHandler	Abstract class to implement to plug-in to iManager to handle custom UI for a specific attribute.
UiHandlerActionTrigger	Class that lists actions that trigger event for a specific field and the action to perform.
UiHandlerContext	Contains information needed for a UiHandler to plug-in to iManager.
Version	Class that represents the iManager version format format: major:minor.rev.onfo For example 2.0.0.0
VetoCreatorTask	Generic Creator Task that will Veto any object creation operation.
VetoDeletor	Generic Deletor that will Veto any delete operation.
VetoMove	Generic Mover that will Veto any move operation.
VetoRename	Generic Rename that will Veto any rename operation.
VetoServerDelete	Deletor that will Veto any delete operation when the server is still up.
XmlElement	Deprecated Use JAXP instead.
XmlElementAttribute	Deprecated Use JAXP instead.
XmlUtils	Provides a set of static utility methods for generating XML data to an output stream.

Exception Summary

Exception	Description
AuthBrokerException	Exception generated by the AuthenticationBroker.
AuthBrokerWrappedRuntimeException	This class is for throwing a AuthBrokerException as a RuntimeException.
BookException	Used only by the book framework.
eDirAccessServiceException	Exception generated by eDAS (eDir Access Service).
FatalPageException	Fatal Exception generated by PropertyBookPage objects.
PageException	Exception generated by Property Pages.
PluginException	Exception generated by a plug-in.

Package com.novell.emframe.dev Description

The dev package contains classes needed for plug-in writers to write plug-ins to iManager. A plug-in consists of Business Logic, Presentation Login, and a Plug-in Descriptor.

Business Logic

• Contained in Java files
• Communicates with iManager through various interfaces (Task and PropertyBookPage being the most prevalent)
• Can put attributes on the HttpRequest for use by the Presentation Logic

Presentation Logic

• Contained in JSP files
• Can read attributes from the HttpRequest given by the Business Logic

Plug-in Descriptor

• Contained in XML files
• Registers roles and tasks with iManager
• A plug-in descriptor can contain multiple roles and tasks

All plug-ins will need at least a Plug-in Descriptor and Business Logic. Only plug-ins that present a User Interface will need Presentation Logic.

There are several different types of plug-ins. The Business Logic needs to extend different classes depending upon the plug-in type:

• Tasks are listed down the left menu in the Roles and Tasks view. Tasks extend the Task class and need to provide JSPs for their Presentation Logic.
• When you modify an object or do operations that require more information than can fit on one page, property book pages can presented in a tabbed UI with control and saving of the information on each property book page controlled a property book. Each PropertyBookPage extends the PropertyBookPage class and need to provide JSPs for their Presentation Logic.
• Plug-ins that want to participate without UI in the object creation process extend the CreatorSilent class.
• Plug-ins that want to provide custom attribute data handling extend the DataHandler class and have no UI.
• Custom object deletion plug-ins extend the Deletor class and need to provide JSPs for their Presentation Logic.
• Custom object move plug-ins extend the Move class and need to provide JSPs for their Presentation Logic.
• Custom object rename plug-ins extend the Rename class and need to provide JSPs for their Presentation Logic.
• Plug-ins that want to control how all plug-ins register with iManager extend the RegistryHandler class and have no UI.

Note on deprecated classes: If you are using classes outside of the dev package in com.novell.nps, these calls have all been depricated and replaced with calls inside of the dev package. Please convert your code so all references to com.novell.nps have been removed.

Since:

1.0