com.novell.admin.ns

Class DefaultNSObject

java.lang.Object

com.novell.admin.ns.NSObject

com.novell.admin.ns.DefaultNSObject

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

LDAPNSObject, MODObject, NDSObject

public abstract class DefaultNSObject
extends NSObject
implements java.io.Serializable

Memory model for objects stored in a namespace.

This model is provided for applications to access and modify all elements associated with a directory object. Elements such as attributes, flags, and schema for an object should be retrieved using this class.

This class reads all attributes of an object into memory. It was designed for property books where one generally needs all the attributes. It's an expensive class to use if one only needs to read or modify a few attributes of an object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable	addedAttributeDefinitions Running list of newly added attribute definitions.
protected AdminNamespace	namespace Namespace that can be used to get class definition
protected ObjectEntry	objectEntry The associated ObjectEntry.

Fields inherited from class com.novell.admin.ns.NSObject

addedAttributes, attributes, classDefinition, deletedAttributes, modifiedAttributes, propertyListeners, revision, shadowSign

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultNSObject(ObjectEntry objEntry, java.util.Vector attributes, long rev) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(ObjectAttribute attr) Adds a newly valued attribute to the object.
boolean	addAuxiliaryClassDefinition(ClassDefinition classDef, ObjectAttribute[] attrs) Adds an auxiliary class Definition.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds this listener to the listener list for this object.
protected void	checkAdd(ObjectAttribute attr, boolean isForAuxClass) Checks to make sure an attribute can be added to this object.
void	clearAddedAttribute(java.lang.String attrName) Removes an attribute from the attributes to add.
void	clearAddedAttributeDefinitions() Removes an attribute from the attributes to add.
void	clearDeletedAttribute(java.lang.String attrName) Removes an attribute from the attributes to delete.
void	clearModifiedAttribute(java.lang.String attrName) Removes an attribute from the attributes to modify.
NSObject	clone(ObjectEntry newIdentity) Creates an exact duplicate of this NSObject but gives it a new identity.
boolean	deleteAttribute(java.lang.String attrName) Deletes a currently valued attribute of this object.
boolean	deleteAuxiliaryClassDefinition(ClassDefinition classDef) Deletes an auxiliary class definition.
java.util.Hashtable	getAddedAttributeDefinitions() Retrieves the attributes that have been added to the object.
java.lang.String[]	getAddedAttributes() Retrieves the attributes that have been added to the object.
ObjectAttribute	getAttribute(java.lang.String attrName) Retrieves a specific attribute of this object.
ObjectAttribute	getAttribute(java.lang.String attrName, AdminNamespaceExceptionReference aneRef, ObjectEntry serverOE) exclude Retrieves a specific attribute from this object.
ObjectAttribute	getAttribute(java.lang.String attrName, int attrFlags, AdminNamespaceExceptionReference aneRef, ObjectEntry serverOE) exclude Retrieves a specific attribute from this object.
java.lang.String[]	getAttributes() Retrieves the names of the valued attributes of the object.
ClassDefinition[]	getClassDefinitions() Retrieves the schema class definition for the object.
java.lang.String[]	getDeletedAttributes() Retrieves the attributes that have been deleted from the object.
java.lang.String[]	getMandatoryAttributes() Retrieves the mandatory attributes of the object.
java.lang.String[]	getModifiedAttributes() Retrieves the attributes that have been modified in the object.
ObjectEntry	getObjectEntry() Retrieves the object entry representation of the object.
java.lang.String[]	getOptionalAttributes() Retrieves the optional attributes of the object.
long	getRevision() Retrieves the revision of the object.
java.lang.String[]	getUnvaluedAttributes() Retrieves the names of the attributes that are not valued.
boolean	isAddPossible(ObjectAttribute attr, boolean isForAuxClass) Checks if the conditions are satisfied for adding an attributes.
boolean	isAttributeMandatory(java.lang.String attrName) Checks to see if a particular attribute is mandatory for the Object Entry's schema class or its associated auxiliary classes.
boolean	isAttributeOptional(java.lang.String attrName) Checks to see if a particular attribute is optional for the Object Entry's schema class or its associated auxiliary classes.
boolean	isNamedBy(java.lang.String attrName) Checks to see if a particular attribute is a naming for the Object Entry's schema class or its associated auxiliary classes.
void	propertyChange(java.beans.PropertyChangeEvent event) Callback for attribute modifications.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes this listener from the listener list for this object.
protected void	setClassDefinition() Sets the class definition for this object.

Methods inherited from class com.novell.admin.ns.NSObject

clone, getShadowSign, setShadowSign

Methods inherited from class java.lang.Object

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

Field Detail

objectEntry

protected ObjectEntry objectEntry

The associated ObjectEntry.

addedAttributeDefinitions

protected java.util.Hashtable addedAttributeDefinitions

Running list of newly added attribute definitions.

namespace

protected AdminNamespace namespace

Namespace that can be used to get class definition

Constructor Detail

DefaultNSObject

protected DefaultNSObject(ObjectEntry objEntry,
                          java.util.Vector attributes,
                          long rev)

Constructor.

Parameters:

objEntry - The object entry representation.

attributes - Vector of ObjectAttributes or Strings if the attributes are to be read later.

rev - revision number of the object.

Method Detail

addAttribute

public void addAttribute(ObjectAttribute attr)
                  throws NamespaceException

Adds a newly valued attribute to the object.

Specified by:

addAttribute in class NSObject

Parameters:

attr - The valued attribute to be added.

Throws:

NamespaceException - Thrown when a condition occurs that disallowed the add.

This may be one of the following conditions.

• NamespaceException.DUPLICATE_ATTRIBUTE
• NamespaceException.INVALID_ATTRIBUTE
• NamespaceException.MANDATORY_ATTRIBUTE
• NamespaceException.READONLY_ATTRIBUTE
• NamespaceException.ATTRIBUTE_NOT_VALUED

getAttribute

public ObjectAttribute getAttribute(java.lang.String attrName)

Retrieves a specific attribute of this object.

Specified by:

getAttribute in class NSObject

Parameters:

attrName - The name of the attribute that is to be retrieved.

Returns:

The ObjectAttribute named by 'attrName' if found, null otherwise.

getAttribute

public ObjectAttribute getAttribute(java.lang.String attrName,
                                    AdminNamespaceExceptionReference aneRef,
                                    ObjectEntry serverOE)
                             throws SPIException,
                                    NamespaceException

exclude Retrieves a specific attribute from this object. If this attribute is in the delayed read list, an actual read will be done. If sucessfully read, that value will then be saved on the NSObject for future reference.

Specified by:

getAttribute in class NSObject

Parameters:

attrName - The name of the attribute that is to be retrieved.

aneRef - If null then any Exception that occurs will be thrown. If this parameter is NOT null, then any Exception that occured will be returned in this AdminNamespaceExceptionReference object and will NOT be thrown. Any ObjectAttribute results (if any or if partial) will then be returned. This uses the USEEXCEPTIONREFERENCE flag to return paritial results if available. If there are no ObjectAttribute results then null will be returned.

serverOE - the server to read from if read is necessary. If null then any server may be used.

Returns:

The ObjectAttribute named by 'attrName' if found, null otherwise.

Throws:

SPIException

NamespaceException

getAttribute

public ObjectAttribute getAttribute(java.lang.String attrName,
                                    int attrFlags,
                                    AdminNamespaceExceptionReference aneRef,
                                    ObjectEntry serverOE)
                             throws SPIException,
                                    NamespaceException

exclude Retrieves a specific attribute from this object. If this attribute is in the delayed read list, an actual read will be done. If sucessfully read, that value will then be saved on the NSObject for future reference.

Specified by:

getAttribute in class NSObject

Parameters:

attrName - The name of the attribute that is to be retrieved.

attrFlags - Any attribute specific flags which needs to be passed. Currently supported flags are: GETATTR_CONTEXTSTATICVALUES - to only get static values (members) for dynamic groups GETATTR_READFROMWRITABLEREPLICA - to cause the read to go to a writeable replica GETATTR_USEEXCEPTIONREFERENCE - Use the lower level protocol's API that returns partial results (dynamic group timeout) instead of throwing an exception.

aneRef - If null then any Exception that occurs will be thrown. If this parameter is NOT null, then any Exception that occured will be returned in this AdminNamespaceExceptionReference object and will NOT be thrown. Any ObjectAttribute results (if any or if partial) will then be returned. This uses the USEEXCEPTIONREFERENCE flag to return paritial results if available. If there are no ObjectAttribute results then null will be returned.

serverOE - the server to read from if read is necessary. If null then any server may be used.

Returns:

The ObjectAttribute named by 'attrName' if found, null otherwise.

Throws:

SPIException

NamespaceException

deleteAttribute

public boolean deleteAttribute(java.lang.String attrName)
                        throws NamespaceException

Deletes a currently valued attribute of this object.

Specified by:

deleteAttribute in class NSObject

Parameters:

attrName - The attribute to be deleted from the object.

Returns:

true if attribute was deleted, false if attribute was not found.

Throws:

NamespaceException - A condition occured which disallowed the delete:

• NamespaceException.MANDATORY_ATTRIBUTE
• NamespaceException.READONLY_ATTRIBUTE

getAddedAttributes

public java.lang.String[] getAddedAttributes()

Retrieves the attributes that have been added to the object.

Specified by:

getAddedAttributes in class NSObject

Returns:

String array of the added attributes.

getAddedAttributeDefinitions

public java.util.Hashtable getAddedAttributeDefinitions()

Retrieves the attributes that have been added to the object.

Returns:

String array of the added attributes.

getAttributes

public java.lang.String[] getAttributes()

Retrieves the names of the valued attributes of the object.

Specified by:

getAttributes in class NSObject

Returns:

A String array of all the attributes.

getMandatoryAttributes

public java.lang.String[] getMandatoryAttributes()

Retrieves the mandatory attributes of the object.

Specified by:

getMandatoryAttributes in class NSObject

Returns:

A String array of all mandatory attributes.

getOptionalAttributes

public java.lang.String[] getOptionalAttributes()

Retrieves the optional attributes of the object.

Specified by:

getOptionalAttributes in class NSObject

Returns:

A String array of all optional attributes.

getUnvaluedAttributes

public java.lang.String[] getUnvaluedAttributes()

Retrieves the names of the attributes that are not valued.

Specified by:

getUnvaluedAttributes in class NSObject

Returns:

A String array of attribute names that are not valued.

getClassDefinitions

public ClassDefinition[] getClassDefinitions()

Retrieves the schema class definition for the object.

Specified by:

getClassDefinitions in class NSObject

Returns:

The schema class definition.

getDeletedAttributes

public java.lang.String[] getDeletedAttributes()

Retrieves the attributes that have been deleted from the object.

Specified by:

getDeletedAttributes in class NSObject

Returns:

A String array of the attributes that were deleted. The attribute names will be lowercased.

getModifiedAttributes

public java.lang.String[] getModifiedAttributes()

Retrieves the attributes that have been modified in the object.

Specified by:

getModifiedAttributes in class NSObject

Returns:

A String array of the attributes that were modified.

getObjectEntry

public ObjectEntry getObjectEntry()

Retrieves the object entry representation of the object.

Specified by:

getObjectEntry in class NSObject

Returns:

objectEntry used to name this object.

getRevision

public long getRevision()

Retrieves the revision of the object.

Specified by:

getRevision in class NSObject

Returns:

The revision.

clone

public NSObject clone(ObjectEntry newIdentity)
               throws NamespaceException

Creates an exact duplicate of this NSObject but gives it a new identity.

Specified by:

clone in class NSObject

Parameters:

newIdentity - The ObjectEntry whose identity is assumed.

Returns:

new NSObject.

Throws:

NamespaceException - NamespaceException.OBJECTTYPE_NOT_VALID is thrown if the newIdentity's type is different from this.

addAuxiliaryClassDefinition

public boolean addAuxiliaryClassDefinition(ClassDefinition classDef,
                                           ObjectAttribute[] attrs)
                                    throws NamespaceException

Adds an auxiliary class Definition.

Specified by:

addAuxiliaryClassDefinition in class NSObject

Parameters:

classDef - The class definition to add.

attrs - The attributes to add.

The only attributes that will be added are those that are not currently valued. If attributes are valued, please modify the value instead of trying to add the attribute.

Returns:

True if all attributes where added, false otherwise.

Throws:

NamespaceException - NamespaceException.MISSING_MANDATORY_ATTRIBUTE

NamespaceException - NamespaceException.NOT_AUXILIARY_CLASS

NamespaceException - NamespaceException.CLASS_NOT_DEFINED

deleteAuxiliaryClassDefinition

public boolean deleteAuxiliaryClassDefinition(ClassDefinition classDef)
                                       throws NamespaceException

Deletes an auxiliary class definition.

Specified by:

deleteAuxiliaryClassDefinition in class NSObject

Parameters:

classDef - The class definition to be deleted.

Returns:

True if the class got deleted, false otherwize.

Throws:

NamespaceException - NamespaceException.NOT_AUXILIARY_CLASS

NamespaceException - NamespaceException.CLASS_NOT_DEFINED

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Callback for attribute modifications.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

event - The property change event that was registered for.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds this listener to the listener list for this object.

Specified by:

addPropertyChangeListener in class NSObject

Parameters:

listener - The listener to be added.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes this listener from the listener list for this object.

Specified by:

removePropertyChangeListener in class NSObject

Parameters:

listener - The listener to be removed.

clearAddedAttribute

public void clearAddedAttribute(java.lang.String attrName)

Removes an attribute from the attributes to add.

Specified by:

clearAddedAttribute in class NSObject

Parameters:

attrName - The valued attribute to be removed from the add list.

clearAddedAttributeDefinitions

public void clearAddedAttributeDefinitions()

Removes an attribute from the attributes to add.

clearDeletedAttribute

public void clearDeletedAttribute(java.lang.String attrName)

Removes an attribute from the attributes to delete.

Specified by:

clearDeletedAttribute in class NSObject

Parameters:

attrName - The valued attribute to be removed from the delete list.

clearModifiedAttribute

public void clearModifiedAttribute(java.lang.String attrName)

Removes an attribute from the attributes to modify.

Specified by:

clearModifiedAttribute in class NSObject

Parameters:

attrName - The valued attribute to be removed from the modify list.

checkAdd

protected void checkAdd(ObjectAttribute attr,
                        boolean isForAuxClass)
                 throws NamespaceException

Checks to make sure an attribute can be added to this object.

Parameters:

attr - The name of the attribute.

isForAuxClass - Attribute is being added due to an Aux class association.

Throws:

NamespaceException - Can not add the attribute to this object.

isAddPossible

public boolean isAddPossible(ObjectAttribute attr,
                             boolean isForAuxClass)
                      throws NamespaceException

Description copied from class: NSObject

Checks if the conditions are satisfied for adding an attributes.

Specified by:

isAddPossible in class NSObject

Throws:

NamespaceException

isAttributeMandatory

public boolean isAttributeMandatory(java.lang.String attrName)

Checks to see if a particular attribute is mandatory for the Object Entry's schema class or its associated auxiliary classes.

Specified by:

isAttributeMandatory in class NSObject

Parameters:

attrName - Name of the attribute to look for.

Returns:

True if attribute is mandatory, false otherwise.

isAttributeOptional

public boolean isAttributeOptional(java.lang.String attrName)

Checks to see if a particular attribute is optional for the Object Entry's schema class or its associated auxiliary classes.

Specified by:

isAttributeOptional in class NSObject

Parameters:

attrName - Name of the attribute to look for.

Returns:

True if attribute is optional, false otherwise.

isNamedBy

public boolean isNamedBy(java.lang.String attrName)

Checks to see if a particular attribute is a naming for the Object Entry's schema class or its associated auxiliary classes.

Specified by:

isNamedBy in class NSObject

Parameters:

attrName - Name of the attribute to look for.

Returns:

True if the attribute is a naming attribute, false otherwise.

setClassDefinition

protected void setClassDefinition()

Sets the class definition for this object.

Specified by:

setClassDefinition in class NSObject