sfi.director.util.ObjectRegistry Class Reference

Every object class the Director knows of needs to be registered in the Object registry. More...

Public Member Functions
	ObjectRegistry (File schemaFile)
	ObjectRegistry (DBObject dbo)
	initializer: create ObjectRegistry entry
String	getIcon ()
	return the name of an icon associated with this ObjectRegistry entry
Vector	getClasses ()
	return the object classes associated with this ObjectRegistry entry
String	getSchema ()
	return the name of the object editor schema associated with this ObjectRegistry entry
boolean	isEditable ()
	returns true if entry is marked editable
boolean	isCreateable ()
	returns true if entry is marked createable
String	name ()
	return the name of this ObjectRegistry entry.
String	getDisplayname ()
	return the display/menu name of this ObjectRegistry entry
String	getDescription ()
	return the description of this ObjectRegistry entry
Vector	getContext ()
	return a list of contexts this object class appears in
DBObject	toDBObject ()
	convert ObjectRegistry object into a DBObject.

Static Public Member Functions
static ObjectRegistry	getByName (String name)
	find an object registry entry by its name
static ObjectRegistry	getByClass (String objclass)
	find an object registry entry by an objectclass.
static ObjectRegistry	getByClass (Vector objclass)
	find best matching object registry entry by object class list.
static ObjectRegistry	getByDisplayname (String name)
	find object registry entry by its displayname
static void	fromSearch (Enumeration search)
	initialize the ObjectRegistry.
static Enumeration	getNewFromContext (final String context)
static Enumeration	getRegistered ()

Detailed Description

Every object class the Director knows of needs to be registered in the Object registry.

The registry glues object classes with user interface

• class names used in menus
• icons used when listing objects
• associated object editor schema
• options: createable / editable
• context objects reasonably are created in
• object classes (LDAP style) covered by this entry

Before using the ObjectRegistry for the first time it needs to be initialized using the fromSearch() method.

See Also

fromSearch(Enumeration)

Constructor & Destructor Documentation

sfi.director.util.ObjectRegistry.ObjectRegistry

(

File

schemaFile

)

References sfi.director.util.ObjectRegistry.name().

Referenced by sfi.director.util.ObjectRegistry.fromSearch(), sfi.director.util.ObjectRegistry.getByClass(), sfi.director.util.ObjectRegistry.getByDisplayname(), and sfi.director.util.ObjectRegistry.getNewFromContext().

sfi.director.util.ObjectRegistry.ObjectRegistry

(

DBObject

dbo

)

initializer: create ObjectRegistry entry

References sfi.director.repository.DBObject.getAttribute(), sfi.director.repository.DBObject.getEValue(), sfi.director.repository.DBObject.getValue(), and sfi.director.util.ObjectRegistry.name().

Member Function Documentation

static void sfi.director.util.ObjectRegistry.fromSearch ( Enumeration  search )

static

initialize the ObjectRegistry.

Read entries from a DBConnection.search() result and fill them into the memory-held database.

See Also

sfi.director.repository.DBConnection::search()

References sfi.director.repository.DBObject.isMember(), sfi.director.util.ObjectRegistry.ObjectRegistry(), and sfi.director.repository.DBConnection.unwrap().

Referenced by sfi.director.util.Init.setup_objectregistry().

static ObjectRegistry sfi.director.util.ObjectRegistry.getByClass ( String  objclass )

static

find an object registry entry by an objectclass.

(Trivial and not very useful - use getByClass(Vector) instead)

See Also

getByClass(Vector)

Referenced by sfi.director.cli.create.edit(), sfi.director.application.FrontendHTTPServer.edit_editor(), sfi.director.application.FrontendInterface.executeCommand(), sfi.director.application.autodoc.DocInfo.genLabel(), and sfi.director.cli.create.prettyPrint().

static ObjectRegistry sfi.director.util.ObjectRegistry.getByClass ( Vector  objclass )

static

find best matching object registry entry by object class list.

References sfi.director.util.ObjectRegistry.ObjectRegistry(), and sfi.director.util.Tools.sort().

static ObjectRegistry sfi.director.util.ObjectRegistry.getByDisplayname ( String  name )

static

find object registry entry by its displayname

References sfi.director.util.ObjectRegistry.getByName(), sfi.director.util.ObjectRegistry.getDisplayname(), and sfi.director.util.ObjectRegistry.ObjectRegistry().

Referenced by sfi.director.cli.create.edit().

static ObjectRegistry sfi.director.util.ObjectRegistry.getByName ( String  name )

static

find an object registry entry by its name

Referenced by sfi.director.application.FrontendHTTPServer.edit_editor(), sfi.director.application.FrontendInterface.executeCommand(), and sfi.director.util.ObjectRegistry.getByDisplayname().

Vector sfi.director.util.ObjectRegistry.getClasses

(

)

return the object classes associated with this ObjectRegistry entry

Referenced by sfi.director.util.ObjectRegistry.getNewFromContext().

Vector sfi.director.util.ObjectRegistry.getContext

(

)

return a list of contexts this object class appears in

Referenced by sfi.director.util.ObjectRegistry.getNewFromContext().

String sfi.director.util.ObjectRegistry.getDescription

(

)

return the description of this ObjectRegistry entry

String sfi.director.util.ObjectRegistry.getDisplayname

(

)

return the display/menu name of this ObjectRegistry entry

Referenced by sfi.director.util.ObjectRegistry.getByDisplayname().

String sfi.director.util.ObjectRegistry.getIcon

(

)

return the name of an icon associated with this ObjectRegistry entry

static Enumeration sfi.director.util.ObjectRegistry.getNewFromContext ( final String  context )

static

References sfi.director.util.ObjectRegistry.getClasses(), sfi.director.util.ObjectRegistry.getContext(), sfi.director.util.ObjectRegistry.isCreateable(), and sfi.director.util.ObjectRegistry.ObjectRegistry().

Referenced by sfi.director.application.FrontendInterface.executeCommand().

static Enumeration sfi.director.util.ObjectRegistry.getRegistered ( )

static

String sfi.director.util.ObjectRegistry.getSchema

(

)

return the name of the object editor schema associated with this ObjectRegistry entry

Referenced by sfi.director.application.DaemonObjectEdit.DaemonObjectEdit().

boolean sfi.director.util.ObjectRegistry.isCreateable

(

)

returns true if entry is marked createable

References sfi.director.util.Options.getOption().

Referenced by sfi.director.util.ObjectRegistry.getNewFromContext().

boolean sfi.director.util.ObjectRegistry.isEditable

(

)

returns true if entry is marked editable

References sfi.director.util.Options.getOption().

String sfi.director.util.ObjectRegistry.name

(

)

return the name of this ObjectRegistry entry.

Referenced by sfi.director.util.ObjectRegistry.ObjectRegistry(), and sfi.director.util.ObjectRegistry.toDBObject().

DBObject sfi.director.util.ObjectRegistry.toDBObject

(

)

convert ObjectRegistry object into a DBObject.

References sfi.director.util.Options.getOption(), sfi.director.util.ObjectRegistry.name(), and sfi.director.repository.DBObject.setDN().

Referenced by sfi.director.application.FrontendInterface.executeCommand().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/util/ObjectRegistry.java