sfi.director.repository.config.DirectoryAccess Class Reference

Inheritance diagram for sfi.director.repository.config.DirectoryAccess:

List of all members.

---

Detailed Description

Access a directory.

The DirectoryAccess class puts some more semantics on an underlying database, e.g. it allows retrieving objects via their names rather than their DNs, search() will only return objects of special classes, etc.

Public Member Functions
	DirectoryAccess ()
void	setSuper (DirectoryAccess parent)
String	getName ()
boolean	matches (DBObject dbo)
void	lock () throws DirectorException
void	unlock () throws DirectorException
String	getFilter (String filter)
String	getFilter (String filter, Options searchopt)
DBObject	get (String name) throws DirectorException
DBObject	get (DN dn) throws DirectorException
void	ensureOu (String ou) throws DirectorException
Enumeration	search (String filter, Options searchopt) throws DirectorException
Enumeration	search (String filter) throws DirectorException
void	replace (String name, DBObject newdbo) throws DirectorException
void	replace (DBObject dbo, DBObject newdbo) throws DirectorException
void	replace (DBObject dbo) throws DirectorException
void	remove (DBObject newdbo) throws DirectorException
void	remove (String name) throws DirectorException
void	add (DBObject newdbo) throws DirectorException
void	add (String name, DBObject newdbo) throws DirectorException
DBObject	getConfig (String name) throws DirectorException
DBObject	getConfig (DBObject dbo) throws DirectorException
	expand attributes inherited from a class.
void	apply (DBObject dbo) throws DirectorException
Enumeration	getElements () throws DirectorException
Enumeration	getElements (String special) throws DirectorException
Enumeration	getElements (String special, String customFilter) throws DirectorException
DBConnection	getDBConnection ()
Enumeration	getClassMembers (String classname) throws DirectorException
	Recursively expand classes, return the names of all the leave members of a class.
Enumeration	getAssignedMembers (DBObject dbo) throws DirectorException
	Given a DBObject expand all its sfiassigned* attributes and return the names of all the leaves.
Static Public Member Functions
static String	escapeFilter (String text)
	Alters text so that it can safely used in a filter.
Protected Member Functions
void	apply (DBObject dbo, boolean expand) throws DirectorException
Protected Attributes
Cache	cache = new Cache( 5, 20 )
DBConnection	mydb
	The underlying database.
String	objFilter = "(objectclass=*)"
	The filter selecting only objects belonging to this directory.
String	lockFeature
	The name of a lock used in locking functions.
String	searchAttribute = "cn"
	The attribute where an objects name is stored.
String	classAttribute
	The name of an attribute where the classes an object belongs to are stored.
String	parentClassAttribute
String	assignedAttribute
	If objects may reference members of this directory assignedAttribute holds the name of the attribute where these references are stored.
String	assignedClassAttribute
	If objects may reference member classes of this directory assignedAttribute holds the name of the attribute where these class references are stored.
DirectoryAccess	classAccess
	If members of this directory are arranged in classes classAccess is the directory where these classes are defined.
String	name
Hashtable	noExpandAttributes
Filter	objAppFilter
Static Protected Attributes
static Lock	lock = null

---

Constructor & Destructor Documentation

sfi.director.repository.config.DirectoryAccess.DirectoryAccess (   )

---

Member Function Documentation

void sfi.director.repository.config.DirectoryAccess.add (  String  name, DBObject  newdbo )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.add (  DBObject  newdbo  )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.apply (  DBObject  dbo, boolean  expand )  throws DirectorException [protected]

void sfi.director.repository.config.DirectoryAccess.apply (  DBObject  dbo  )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.ensureOu (  String  ou  )  throws DirectorException

static String sfi.director.repository.config.DirectoryAccess.escapeFilter (  String  text  )  [static]

Alters text so that it can safely used in a filter.

DBObject sfi.director.repository.config.DirectoryAccess.get (  DN  dn  )  throws DirectorException

DBObject sfi.director.repository.config.DirectoryAccess.get (  String  name  )  throws DirectorException

Reimplemented in sfi.director.repository.config.AppPackages.

Enumeration sfi.director.repository.config.DirectoryAccess.getAssignedMembers (  DBObject  dbo  )  throws DirectorException

Given a DBObject expand all its sfiassigned* attributes and return the names of all the leaves.

Enumeration sfi.director.repository.config.DirectoryAccess.getClassMembers (  String  classname  )  throws DirectorException

Recursively expand classes, return the names of all the leave members of a class.

DBObject sfi.director.repository.config.DirectoryAccess.getConfig (  DBObject  dbo  )  throws DirectorException

expand attributes inherited from a class.

DBObject sfi.director.repository.config.DirectoryAccess.getConfig (  String  name  )  throws DirectorException

DBConnection sfi.director.repository.config.DirectoryAccess.getDBConnection (   )

Enumeration sfi.director.repository.config.DirectoryAccess.getElements (  String  special, String  customFilter )  throws DirectorException

Enumeration sfi.director.repository.config.DirectoryAccess.getElements (  String  special  )  throws DirectorException

Enumeration sfi.director.repository.config.DirectoryAccess.getElements (   )  throws DirectorException

String sfi.director.repository.config.DirectoryAccess.getFilter (  String  filter, Options  searchopt )

String sfi.director.repository.config.DirectoryAccess.getFilter (  String  filter  )

String sfi.director.repository.config.DirectoryAccess.getName (   )

void sfi.director.repository.config.DirectoryAccess.lock (   )  throws DirectorException

boolean sfi.director.repository.config.DirectoryAccess.matches (  DBObject  dbo  )

Reimplemented in sfi.director.repository.config.Top.

void sfi.director.repository.config.DirectoryAccess.remove (  String  name  )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.remove (  DBObject  newdbo  )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.replace (  DBObject  dbo  )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.replace (  DBObject  dbo, DBObject  newdbo )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.replace (  String  name, DBObject  newdbo )  throws DirectorException

Enumeration sfi.director.repository.config.DirectoryAccess.search (  String  filter  )  throws DirectorException

Enumeration sfi.director.repository.config.DirectoryAccess.search (  String  filter, Options  searchopt )  throws DirectorException

void sfi.director.repository.config.DirectoryAccess.setSuper (  DirectoryAccess  parent  )

void sfi.director.repository.config.DirectoryAccess.unlock (   )  throws DirectorException

---

Member Data Documentation

String sfi.director.repository.config.DirectoryAccess.assignedAttribute [protected]

If objects may reference members of this directory assignedAttribute holds the name of the attribute where these references are stored. See also: getAssignedMembers(DBObject)

String sfi.director.repository.config.DirectoryAccess.assignedClassAttribute [protected]

If objects may reference member classes of this directory assignedAttribute holds the name of the attribute where these class references are stored. See also: getAssignedMembers(DBObject)

Cache sfi.director.repository.config.DirectoryAccess.cache = new Cache( 5, 20 ) [protected]

DirectoryAccess sfi.director.repository.config.DirectoryAccess.classAccess [protected]

If members of this directory are arranged in classes classAccess is the directory where these classes are defined.

String sfi.director.repository.config.DirectoryAccess.classAttribute [protected]

The name of an attribute where the classes an object belongs to are stored. See also: apply(DBObject)

Lock sfi.director.repository.config.DirectoryAccess.lock = null [static, protected]

String sfi.director.repository.config.DirectoryAccess.lockFeature [protected]

The name of a lock used in locking functions.

DBConnection sfi.director.repository.config.DirectoryAccess.mydb [protected]

The underlying database.

String sfi.director.repository.config.DirectoryAccess.name [protected]

Hashtable sfi.director.repository.config.DirectoryAccess.noExpandAttributes [protected]

Filter sfi.director.repository.config.DirectoryAccess.objAppFilter [protected]

String sfi.director.repository.config.DirectoryAccess.objFilter = "(objectclass=*)" [protected]

The filter selecting only objects belonging to this directory.

String sfi.director.repository.config.DirectoryAccess.parentClassAttribute [protected]

String sfi.director.repository.config.DirectoryAccess.searchAttribute = "cn" [protected]

The attribute where an objects name is stored. See also: get(String)

---

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

• director/repository/config/DirectoryAccess.java

---