org.dmd.dmr.server.ldap.extended

Class LDAPHierarchicObject

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dmr.server.base.generated.dmw.HierarchicObjectDMW

org.dmd.dmr.server.base.extended.HierarchicObject

org.dmd.dmr.server.ldap.generated.dmw.LDAPHierarchicObjectDMW

org.dmd.dmr.server.ldap.extended.LDAPHierarchicObject

All Implemented Interfaces:

Comparable<HierarchicObject>, DmcContainerIF, DmcNamedObjectIF

public class LDAPHierarchicObject
extends LDAPHierarchicObjectDMW

The LDAPHierarchicObject class extends the LDAPHierarchicObjectDMW class and provides utilities to arrange objects into a hierarchy based on their Fully Qualified Names (FQNs). FQNs are comprised of tuples of the form :/:name attribute>/... where CLASS is the shortest form of the class name and "name attribute" is the value of the naming attribute for the class.

The object will maintain a Distinguished Name (DN) value as well. For LDAP, DNs are composed of tuples as well, but, they are in reverse order from FQNs, they start at the leaf of a hierarchy and proceed towards the root. Also, they use the name of the naming attribute in place of the CLASS (as in the FQN). However, we make things a bit easier on ourselves by provide unique naming attributes for every class so that, on the basis of the naming attribute, we can determine the type of class to instantiate when we pull an object from the directory.

For example, if we have an object with the following FQN: NF:nodes/MF:ab/MF:67/MF:b3 The corresponding DN is: mfid=b3,mfid=67,mfid=ab,nfid=nodes

When the object associated with this DN is read from the directory, we simply grab the first name attribute value and see what class it's associated with and instantiate that Dark Matter Wrapper object

Field Summary

Fields inherited from class org.dmd.dmr.server.base.extended.HierarchicObject

parent

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	LDAPHierarchicObject()
protected	LDAPHierarchicObject(LDAPHierarchicObjectDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
RepositoryIF	getRepository()
String	getRepositoryID() Returns the name of this object in the repository.
void	resetParent(HierarchicObject newParent) This method rehomes a branch of hierarchic objects to sit beneath the specified parent.
void	setParentObject(HierarchicObject p) This method sets the parent object for this object and reconstructs the FQN as appropriate.
void	setParentObject(HierarchicObject p, boolean buildFQN) This method sets the parent object for this object and reconstructs the FQN as appropriate.
void	setRepository(RepositoryIF r)
void	setRepositoryID(String id) Sets the name of this object as used in the repository.

Methods inherited from class org.dmd.dmr.server.ldap.generated.dmw.LDAPHierarchicObjectDMW

cloneIt, equals, getDMO, getFQN, getModificationRecorder, getObjectName, getObjectNameAttribute, hashCode, remFQN, setFQN, setFQN

Methods inherited from class org.dmd.dmr.server.base.extended.HierarchicObject

addSubComponent, compareTo, get, getName, getParentObject, getSubComps, removeSubComponent, removeSubcomponents, saveToBuffer, saveToBuffer, saveToFile, saveToFile, setSort, size

Methods inherited from class org.dmd.dmr.server.base.generated.dmw.HierarchicObjectDMW

getFile, getLineNumber, remFile, remLineNumber, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LDAPHierarchicObject

protected LDAPHierarchicObject(LDAPHierarchicObjectDMO obj,
                               ClassDefinition cd)

LDAPHierarchicObject

public LDAPHierarchicObject()

Method Detail

setParentObject

public void setParentObject(HierarchicObject p)
                     throws ResultException,
                            DmcValueException

This method sets the parent object for this object and reconstructs the FQN as appropriate.

Overrides:

setParentObject in class HierarchicObject

Parameters:

p - the parent object.

Throws:

ResultException - if there's no value for the naming attribute.

DmcValueException

setParentObject

public void setParentObject(HierarchicObject p,
                            boolean buildFQN)
                     throws ResultException,
                            DmcValueException

This method sets the parent object for this object and reconstructs the FQN as appropriate. Set the buildFQN flag to false if the object already has its FQNs set e.g. when it has been retrieved from the repository.

Overrides:

setParentObject in class HierarchicObject

Parameters:

p - the parent object.

buildFQN - Indicates if we need to reset this object's FQNs based on the parent.

Throws:

ResultException - if there's no value for the naming attribute.

DmcValueException

resetParent

public void resetParent(HierarchicObject newParent)
                 throws ResultException,
                        DmcValueException

This method rehomes a branch of hierarchic objects to sit beneath the specified parent. The method recurses through the entire subtree and renames the objects based on the new parent.

Overrides:

resetParent in class HierarchicObject

Parameters:

newParent -

Throws:

DmcValueException

ResultException

getRepositoryID

public String getRepositoryID()
                       throws ResultException

Returns the name of this object in the repository.

Returns:

The repository ID.

Throws:

ResultException

setRepositoryID

public void setRepositoryID(String id)

Sets the name of this object as used in the repository.

Parameters:

id -

setRepository

public void setRepository(RepositoryIF r)

getRepository

public RepositoryIF getRepository()