com.novell.emframe.dev
Class GlobalRegistry

java.lang.Object
  com.novell.emframe.dev.GlobalRegistry

public class GlobalRegistry

extends java.lang.Object

Class used to build the Global Registry of plug-ins for iManager. Use this class to dynamically add plug-ins to iManager. iManager will automatically create the Global Registry and read in all .xml files found in webapps\nps\portal\modules\*\plugins directories.

Constructor Summary

GlobalRegistry()

Method Summary

static void	addNode(org.jdom.Document doc, java.io.File xmlFile) Add the node contained in the XML Document to the GlobalRegistry.
static org.jdom.Document	getAttributeHandlerDoc(java.lang.String attributeName) Returns the attribute handler for a given attribute name.
static java.lang.String	getAttributeResourceFile(java.lang.String attributeName) Returns the resource properties file for a given attribute name.
static java.util.Vector	getBlockedPageIds(java.lang.String strType) Returns a list of blocked PropertyBookPages for a given object type.
static org.jdom.Document	getClassLoaderDoc(java.lang.String descriptorDir) Returns the class loader for a specified descriptor ("page", "task", "book", or "chained-task").
static org.jdom.Document	getCreatorDoc(java.lang.String strType) Returns the create object plug-in for a given object type.
static java.util.ArrayList	getCreatorSilentChainingPlugins(java.lang.String objectTypeName) Returns a list of object creator plug-ins that silently plug into the object creation chain for a given object type.
static org.jdom.Document	getDefaultUiHandlerDoc(java.lang.String syntaxName, java.lang.String attributeName, java.lang.String objectTypeName, java.lang.String[] objectSuperClasses, boolean multivalued, boolean readOnlyEnabled, java.lang.String client) Returns the default UI handler for a given syntax name.
static org.jdom.Document	getDeletorDoc(java.lang.String strType) Returns the delete object plug-in for a given object type.
static java.util.ArrayList	getGatewayConfigPlugins() Returns a list of printer gateway plug-ins.
static org.jdom.Document	getMoveDoc(java.lang.String strType) Returns the move object plug-in for a given object type.
static java.lang.String	getObjectTypeResourceFile(java.lang.String objectTypeName) Returns the resource properties file for a given object type.
static java.util.Vector	getPageDocs(java.lang.String strType) Returns a list of registered PropertyBookPages for a given object type.
static org.jdom.Document	getPluginDocument(java.lang.String id) Returns an XML Document for a specified plug-in.
static java.util.ArrayList	getPrinterControlPlugins() Returns a list of printer control plugins.
static java.util.Vector	getPrivatePageDocs(java.lang.String strType) Returns a list of registered private PropertyBookPages for a given object type.
static org.jdom.Document	getRenameDoc(java.lang.String strType) Returns the rename object plug-in for a given object type.
static java.util.ArrayList	getRolesInCategory(java.lang.String category) Deprecated. Replaced by getRolesInView()
static java.util.ArrayList	getRolesInView(java.lang.String view) Returns a list of roles to display in the specified view.
static org.jdom.Document	getSyntaxHandlerDoc(java.lang.String syntaxName) Returns the syntax handler for a given syntax name.
static java.util.ArrayList	getTasksInRole(java.lang.String role) Returns a list of tasks to display in the specified role.
static org.jdom.Document[]	getUiHandlerDocs(java.lang.String syntaxName, java.lang.String attributeName, java.lang.String objectTypeName, java.lang.String[] objectSuperClasses, boolean multivalued, boolean readOnlyEnabled, java.lang.String client) Returns an array of UI handlers for a given syntax name.
static java.util.ArrayList	getViews() Returns a list of views available in iManager.
static void	removeNode(org.jdom.Document doc) Remove a node from the GlobalRegistry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlobalRegistry

public GlobalRegistry()

Method Detail

addNode

public static void addNode(org.jdom.Document doc,
                           java.io.File xmlFile)

Add the node contained in the XML Document to the GlobalRegistry.

Parameters:

doc - XML Document containg the node to add

xmlFile - File location of the XML Document

getAttributeHandlerDoc

public static org.jdom.Document getAttributeHandlerDoc(java.lang.String attributeName)

Returns the attribute handler for a given attribute name.

Parameters:

attributeName - String containing the attribute name

Returns:

XML Document describing the attribute handler

getAttributeResourceFile

public static java.lang.String getAttributeResourceFile(java.lang.String attributeName)

Returns the resource properties file for a given attribute name. Allows translations of attribute names.

Parameters:

attributeName - String containing the attribute name

Returns:

String containing the resource properties file where translations for the attribute name can be found

getBlockedPageIds

public static java.util.Vector getBlockedPageIds(java.lang.String strType)

Returns a list of blocked PropertyBookPages for a given object type. Blocked pages don't show up in the "ModifyObjectTask".

Parameters:

strType - String containing the object type

Returns:

Vector of XML Document objects describing the PropertyBookPage

getClassLoaderDoc

public static org.jdom.Document getClassLoaderDoc(java.lang.String descriptorDir)

Returns the class loader for a specified descriptor ("page", "task", "book", or "chained-task").

Parameters:

descriptorDir - String containing the descriptor ("page", "task", "book", or "chained-task")

Returns:

XML Document describing the class loader

getCreatorDoc

public static org.jdom.Document getCreatorDoc(java.lang.String strType)

Returns the create object plug-in for a given object type.

Parameters:

strType - String containing the object type

Returns:

XML Document describing the creator plug-in

getCreatorSilentChainingPlugins

public static java.util.ArrayList getCreatorSilentChainingPlugins(java.lang.String objectTypeName)

Returns a list of object creator plug-ins that silently plug into the object creation chain for a given object type.

Parameters:

objectTypeName - String containing the object type

Returns:

ArrayList of XML Document objects describing the object creator plug-in

getDefaultUiHandlerDoc

public static org.jdom.Document getDefaultUiHandlerDoc(java.lang.String syntaxName,
                                                       java.lang.String attributeName,
                                                       java.lang.String objectTypeName,
                                                       java.lang.String[] objectSuperClasses,
                                                       boolean multivalued,
                                                       boolean readOnlyEnabled,
                                                       java.lang.String client)

Returns the default UI handler for a given syntax name. Used mainly by iManager's TemplateBuilder.

Parameters:

syntaxName - String containing the syntax name

attributeName - String containing the attribute name

objectTypeName - String containing the object's type name

objectSuperClasses - String array containing the object's super classes

multivalued - boolean true if the attribute is multivalued, false if not

readOnlyEnabled - boolean true if the UI handler only displays read only, false if not

client - String containing the device type to check against the supported-device-type list

Returns:

XML Document describing the UI handler

getDeletorDoc

public static org.jdom.Document getDeletorDoc(java.lang.String strType)

Returns the delete object plug-in for a given object type.

Parameters:

strType - String containing the object type

Returns:

XML Document describing the deletor plug-in

getGatewayConfigPlugins

public static java.util.ArrayList getGatewayConfigPlugins()

Returns a list of printer gateway plug-ins.

Returns:

ArrayList containing XML Document objects describing the plug-in

getMoveDoc

public static org.jdom.Document getMoveDoc(java.lang.String strType)

Returns the move object plug-in for a given object type.

Parameters:

strType - String containing the object type

Returns:

XML Document describing the move plug-in

getObjectTypeResourceFile

public static java.lang.String getObjectTypeResourceFile(java.lang.String objectTypeName)

Returns the resource properties file for a given object type. Allows translations of object type names.

Parameters:

objectTypeName - String containing the object type name

Returns:

String containing the resource properties file where translations for the object type name can be found

getPageDocs

public static java.util.Vector getPageDocs(java.lang.String strType)

Returns a list of registered PropertyBookPages for a given object type. Doesn't do inheritance automatically.

Parameters:

strType - String containing the object type

Returns:

Vector of XML Document objects describing the PropertyBookPage

getPluginDocument

public static org.jdom.Document getPluginDocument(java.lang.String id)

Returns an XML Document for a specified plug-in.

Parameters:

id - String containing the unique ID of the plug-in

Returns:

XML Document containing the descriptor registering the plug-in

getPrinterControlPlugins

public static java.util.ArrayList getPrinterControlPlugins()

Returns a list of printer control plugins.

Returns:

ArrayList containing XML Document objects describing the plug-in

getPrivatePageDocs

public static java.util.Vector getPrivatePageDocs(java.lang.String strType)

Returns a list of registered private PropertyBookPages for a given object type. Private pages don't show up in the "ModifyObjectTask". Doesn't do inheritance automatically.

Parameters:

strType - String containing the object type

Returns:

Vector of XML Document objects describing the PropertyBookPage

getRenameDoc

public static org.jdom.Document getRenameDoc(java.lang.String strType)

Returns the rename object plug-in for a given object type.

Parameters:

strType - String containing the object type

Returns:

XML Document describing the renme plug-in

getRolesInCategory

public static java.util.ArrayList getRolesInCategory(java.lang.String category)

Deprecated. Replaced by getRolesInView()

Returns a list of roles to display in the specified category.

Parameters:

category - String containing the name of the category

Returns:

ArrayList containing XML Document objects describing the role

See Also:

getRolesInView(java.lang.String)

getRolesInView

public static java.util.ArrayList getRolesInView(java.lang.String view)

Returns a list of roles to display in the specified view.

Parameters:

view - String containing the unique ID of the view

Returns:

ArrayList containing XML Document objects describing the role

getSyntaxHandlerDoc

public static org.jdom.Document getSyntaxHandlerDoc(java.lang.String syntaxName)

Returns the syntax handler for a given syntax name.

Parameters:

syntaxName - String containing the syntax name

Returns:

XML Document describing the syntax handler

getTasksInRole

public static java.util.ArrayList getTasksInRole(java.lang.String role)

Returns a list of tasks to display in the specified role.

Parameters:

role - String containing the unique ID of the role

Returns:

ArrayList containing XML Document objects describing the task

getUiHandlerDocs

public static org.jdom.Document[] getUiHandlerDocs(java.lang.String syntaxName,
                                                   java.lang.String attributeName,
                                                   java.lang.String objectTypeName,
                                                   java.lang.String[] objectSuperClasses,
                                                   boolean multivalued,
                                                   boolean readOnlyEnabled,
                                                   java.lang.String client)

Returns an array of UI handlers for a given syntax name. Used mainly by iManager's TemplateBuilder.

Parameters:

syntaxName - String containing the syntax name

attributeName - String containing the attribute name

objectTypeName - String containing the object's type name

objectSuperClasses - String array containing the object's super classes

multivalued - boolean true if the attribute is multivalued, false if not

readOnlyEnabled - boolean true if the UI handler only displays read only, false if not

client - String containing the device type to check against the supported-device-type list

Returns:

XML Document array describing the UI handlers

getViews

public static java.util.ArrayList getViews()

Returns a list of views available in iManager.

Returns:

ArrayList of XML Document objects describing the view

removeNode

public static void removeNode(org.jdom.Document doc)

Remove a node from the GlobalRegistry.

Parameters:

doc - XML Document containing the node to remove