com.novell.admin.ns
Interface AdminNamespace

All Superinterfaces:

DeferParentNamespace, NamespaceSnapin, NamespaceSnapinRev2, Snapin

All Known Subinterfaces:

LDAPNamespace, NDSNamespace

public interface AdminNamespace

extends NamespaceSnapin, NamespaceSnapinRev2, DeferParentNamespace

This interface describes a namespace service for object administration.

Method Summary

boolean	compareAttribute(ObjectEntry obj, ObjectAttribute objAttr) Determines if an object contains the specified attribute with the specified value.
void	create(NSObject obj) Creates a new object in the namespace.
NSObject	createNSObject(ObjectEntry objEntry, java.util.Vector attributes) Creates a new NSObject.
NSObject	createNSObject(ObjectEntry objEntry, java.util.Vector attributes, boolean bValidate) Creates a new NSObject.
NSObject	createNSObject(ObjectEntry objEntry, java.util.Vector attributes, long revision) Deprecated. Please use createNSObject(ObjectEntry objEntry, Vector attributes).
ObjectEntry	createObjectEntry(ObjectEntry parent, java.lang.String child, java.lang.String className) Creates an ObjectEntry for a child object that does not exist in the namespace.
void	delete(ObjectEntry obj) Deletes an object from the namespace.
void	deleteAttributeValues(ObjectEntry obj, ObjectAttribute attr) Deletes an object attribute value.
boolean	doesExist(ObjectEntry parentEntry, java.lang.String objStr) Checks to see if an object exists in the namespace.
void	freeDetails(java.lang.Object key) Removes an NSObject from the cache.
ObjectAttribute	getAttribute(ObjectEntry obj, java.lang.String attrStr) Get the attribute value(s) for a namespace objects particular attribute.
AttributeDefinition	getAttributeDefinition(ObjectEntry ctxObj, java.lang.String attrName) Returns an attribute definition for a specific attribute in a specific context.
ObjectAttribute[]	getAttributes(ObjectEntry obj, java.lang.String[] attrStrings) Reads an existing object in the namespace and returns an array containing the object's attributes, including their values.
ObjectEntryEnumeration	getChildren(ObjectEntry obj) Returns an ObjectEntry's child objects.
ObjectEntryEnumeration	getChildren(ObjectEntry obj, ResultModifier modifiers) Returns an ObjectEntry's child objects according to a filtered request.
ClassDefinition	getClassDefinition(ObjectEntry ctxObj, java.lang.String className) Reads the namespace schema and returns a class definition for a specific class.
java.lang.Object	getContext(ObjectEntry oe) Helper method to get the LDAP connection
java.util.Date	getCreationTime(ObjectEntry objectEntry) Returns the time of the creation of the object in the Directory.
NSObject	getDetails(ObjectEntry obj) Reads the details for an existing object and returns an NSObject for that object.
NSObject	getDetails(ObjectEntry obj, java.lang.Object key) Reads the details for an existing object and returns an NSObject for that object.
java.lang.String	getFullName(ObjectEntry objEntry) Returns the full name or path of an object.
java.lang.String	getFullyTypedName(ObjectEntry objectEntry) Returns the object's fully typed name, not including the root entry.
java.util.Date	getLastModificationTime(ObjectEntry objectEntry) Returns the time of the last modification of the object in the Directory.
int	getMaxNameLength(ObjectEntry parentOE, AttributeDefinition attrDef) Returns the maximum character length for a new object name, depending on the namespace.
java.lang.String[]	getNameComponents(ObjectEntry oe) Parses an object's full name into components.
Rights	getObjectEffectiveRights(ObjectEntry objForInquire, ObjectEntry trustee) Returns the effective rights of an object to a target object.
ObjectEntry	getObjectEntry(ObjectEntry parentEntry, java.lang.String objEntryStr) Returns an ObjectEntry for a valid object name.
ObjectEntry	getObjectEntry(java.lang.String objEntryStr) Returns an ObjectEntry for a valid object name.
ObjectType	getObjectType(ObjectEntry obj, java.lang.String className) Returns an object type for the given object entry.
ObjectType[]	getObjectType(ObjectEntry tree, java.lang.String[] objectFDN) Get an ObjectType for each object FDN.
ObjectType[]	getObjectTypes(ObjectEntry obj) Returns all of the possible object types for this namespace.
Rights[]	getPropertyEffectiveRights(ObjectEntry objForInquire, ObjectEntry trustee, java.lang.String[] attrNames) Returns the effective rights of an object to a target object's attributes.
SchemaDefinition	getSchemaDefinition(ObjectEntry ctxObj) Returns the schema definition from a given context.
ObjectEntry	move(ObjectEntry objToMove, ObjectEntry destination) Moves an object to another location in the namespace.
ObjectEntry	rename(ObjectEntry fromObjEntry, java.lang.String newName) Renames an object.
void	setAttribute(ObjectEntry obj, ObjectAttribute attribute) Set the attribute value for a namespace objects particular attribute.
void	setAttributes(ObjectEntry obj, ObjectAttribute[] attributes) Writes attributes, including values, to an existing object.
void	update(NSObject obj) Writes object changes to the namespace.

Methods inherited from interface com.novell.application.console.snapin.NamespaceSnapin

getChildContainers, getInitialObjectEntries, getUniqueID, getUnrootedName

Methods inherited from interface com.novell.application.console.snapin.Snapin

getSnapinDescription, getSnapinName, initSnapin, shutdownSnapin

Methods inherited from interface com.novell.application.console.snapin.NamespaceSnapinRev2

getInitialObjectEntries

Methods inherited from interface com.novell.application.console.snapin.DeferParentNamespace

getParentAndSimpleName

Method Detail

compareAttribute

public boolean compareAttribute(ObjectEntry obj,
                                ObjectAttribute objAttr)
                         throws NamespaceException,
                                SPIException

Determines if an object contains the specified attribute with the specified value. Only a single value may be specified for comparison.

Parameters:

obj - The object to test.

objAttr - The attribute and value to test for.

Returns:

true if the object contains this value in this attribute, false if not.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException - Thrown when the namespace detects an error.

create

public void create(NSObject obj)
            throws SPIException,
                   SnapinVetoException

Creates a new object in the namespace.

Parameters:

obj - The object to create. This object must be complete with its attributes and values.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the create.

createNSObject

public NSObject createNSObject(ObjectEntry objEntry,
                               java.util.Vector attributes)
                        throws NamespaceException

Creates a new NSObject.

Use this method to create an NSObject when the object does not exist in the namespace. Then use the create method to write the object to the namespace.

Parameters:

objEntry - The object entry representing the new NSObject.

attributes - Vector of ObjectAttributes for the object.

Returns:

The created NSObject.

Throws:

NamespaceException - Thrown when the namespace detects an error.

createNSObject

public NSObject createNSObject(ObjectEntry objEntry,
                               java.util.Vector attributes,
                               boolean bValidate)
                        throws NamespaceException

Creates a new NSObject.

Parameters:

objEntry - The object entry representation.

attributes - Vector of ObjectAttributes.

bValidate - true to validate the object for mandatory and naiming attributes

Returns:

The created NSObject.

Throws:

NamespaceException - Thrown when the namespace detects an error.

createNSObject

public NSObject createNSObject(ObjectEntry objEntry,
                               java.util.Vector attributes,
                               long revision)
                        throws NamespaceException

Deprecated. Please use createNSObject(ObjectEntry objEntry, Vector attributes).

Creates a new NSObject.

Parameters:

objEntry - The object entry representation.

attributes - Vector of ObjectAttributes.

revision - Always pass 0 here since there is no previous revision.

Returns:

The created NSObject.

Throws:

NamespaceException - Thrown when the namespace detects an error.

createObjectEntry

public ObjectEntry createObjectEntry(ObjectEntry parent,
                                     java.lang.String child,
                                     java.lang.String className)
                              throws NamespaceException,
                                     SPIException

Creates an ObjectEntry for a child object that does not exist in the namespace.

Parameters:

parent - The ObjectEntry of the child's parent.

child - The name of the child object.

className - The class type of the child object.

Returns:

The object entry for the child object.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException - Thrown when the namespace detects an error.

delete

public void delete(ObjectEntry obj)
            throws SPIException,
                   SnapinVetoException

Deletes an object from the namespace.

Parameters:

obj - The object entry representing the object to delete.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the delete.

deleteAttributeValues

public void deleteAttributeValues(ObjectEntry obj,
                                  ObjectAttribute attr)
                           throws SPIException

Deletes an object attribute value.

Parameters:

obj - The object that contains the attribute.

attr - The attribute.

Throws:

SPIException - Thrown by the service provider.

doesExist

public boolean doesExist(ObjectEntry parentEntry,
                         java.lang.String objStr)
                  throws SPIException

Checks to see if an object exists in the namespace.

Parameters:

parentEntry - The parent of the object being checked.

objStr - A string representing the object being checked.

Returns:

True if the object exists, or false if the object does not exist.

Throws:

SPIException - Thrown when the service provider returns an error.

freeDetails

public void freeDetails(java.lang.Object key)

Removes an NSObject from the cache.

Parameters:

key - The key into the hash table where the NSObject is stored.

getAttribute

public ObjectAttribute getAttribute(ObjectEntry obj,
                                    java.lang.String attrStr)
                             throws SPIException

Get the attribute value(s) for a namespace objects particular attribute.

Parameters:

obj - The object that contains the attribute.

attrStr - The attribute to get values for.

Returns:

The ObjectAttribute with values.

Throws:

SPIException - Refer to SPIException documentation.

getAttributeDefinition

public AttributeDefinition getAttributeDefinition(ObjectEntry ctxObj,
                                                  java.lang.String attrName)
                                           throws SPIException,
                                                  NamespaceException

Returns an attribute definition for a specific attribute in a specific context.

Parameters:

ctxObj - The context from which the attribute definition is being retrieved.

attrName - The name of the attribute whose definition is being retrieved.

Returns:

The attribute definition.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException - Thrown when the namespace detects an error.

getAttributes

public ObjectAttribute[] getAttributes(ObjectEntry obj,
                                       java.lang.String[] attrStrings)
                                throws SPIException,
                                       NamespaceException

Reads an existing object in the namespace and returns an array containing the object's attributes, including their values.

Parameters:

obj - The object for which to obtain attributes.

attrStrings - The object attributes to obtain.

Returns:

An array of ObjectAttribute objects.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException - Thrown when the namespace detects an error.

getChildren

public ObjectEntryEnumeration getChildren(ObjectEntry obj)
                                   throws SPIException

Returns an ObjectEntry's child objects.

Parameters:

obj - The ObjectEntry for which to return the child objects.

Returns:

An enumeration of the ObjectEntry's child objects.

Throws:

SPIException - Thrown when the service provider returns an error.

getChildren

public ObjectEntryEnumeration getChildren(ObjectEntry obj,
                                          ResultModifier modifiers)
                                   throws SPIException

Returns an ObjectEntry's child objects according to a filtered request.

The modifiers parameter by default allows the objects to be returned by name and object type.

Specified by:

getChildren in interface NamespaceSnapin

Parameters:

obj - The ObjectEntry for which to return the child objects.

modifiers - Determines how the child list is built.

Returns:

An enumeration of the ObjectEntry's child objects.

Throws:

SPIException - Thrown when the service provider returns an error.

See Also:

ObjectEntryEnumeration

getClassDefinition

public ClassDefinition getClassDefinition(ObjectEntry ctxObj,
                                          java.lang.String className)
                                   throws SPIException,
                                          NamespaceException

Reads the namespace schema and returns a class definition for a specific class.

Parameters:

ctxObj - The context from which the class definition is being retrieved.

className - The name of the class whose definition is being retrieved.

Returns:

The class definition.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException - Thrown when the namespace detects an error.

getContext

public java.lang.Object getContext(ObjectEntry oe)
                            throws SPIException

Helper method to get the LDAP connection

Parameters:

oe - The object entry.

Returns:

The LDAP connection.

Throws:

SPIException - Refer to SPIException documentation.

getCreationTime

public java.util.Date getCreationTime(ObjectEntry objectEntry)
                               throws SPIException

Returns the time of the creation of the object in the Directory.

Parameters:

objectEntry - The object.

Returns:

The date the object was created.

Throws:

SPIException - Thrown by the service provider.

getDetails

public NSObject getDetails(ObjectEntry obj)
                    throws SPIException

Reads the details for an existing object and returns an NSObject for that object.

Parameters:

obj - The ObjectEntry for which to return the NSObject.

Returns:

The NSObject for the namespace object.

Throws:

SPIException - Thrown when the service provider returns an error.

getDetails

public NSObject getDetails(ObjectEntry obj,
                           java.lang.Object key)
                    throws SPIException

Reads the details for an existing object and returns an NSObject for that object.

This method provides the option of caching the NSObjects using the "key" parameter. This allows the NSObject to be retrieved from the cache rather than searching the namespace.

Parameters:

obj - The ObjectEntry for which to return the NSObject.

key - The key into the hash table where the NSObject is stored.

Returns:

The NSObject for the namespace object.

Throws:

SPIException - Thrown when the service provider returns an error.

getFullName

public java.lang.String getFullName(ObjectEntry objEntry)

Returns the full name or path of an object.

Specified by:

getFullName in interface NamespaceSnapin

Parameters:

objEntry - The object whose name is being retrieved.

Returns:

The full name or path of the object.

getFullyTypedName

public java.lang.String getFullyTypedName(ObjectEntry objectEntry)

Returns the object's fully typed name, not including the root entry.

NDAP example: CN=admin.OU=engineering.O=novell

LDAP example: cn=admin,ou=engineering,o=novell

For LDAP this is identical to AdminNamespace.getFullName(oe) or getUnrootedName(oe)

Parameters:

objectEntry - The object that is to be fully typed.

Returns:

The fully typed distinguished name.

getLastModificationTime

public java.util.Date getLastModificationTime(ObjectEntry objectEntry)
                                       throws SPIException

Returns the time of the last modification of the object in the Directory.

Parameters:

objectEntry - The object.

Returns:

The date the object was last modified.

Throws:

SPIException - Thrown by the service provider.

getMaxNameLength

public int getMaxNameLength(ObjectEntry parentOE,
                            AttributeDefinition attrDef)
                     throws SPIException

Returns the maximum character length for a new object name, depending on the namespace.

This method is used most often before creating a new object to determine a valid length of the object's name.

Some namespaces may limit the number of characters in an object name. For example, NDS limits a full distinguished name, including delimiters, to 256 characters.

Parameters:

parentOE - The parent under which the object will be created.

attrDef - The attribute definition of the naming attribute for the object to be created.

Returns:

The max length of the name that can be used for the object.

Throws:

SPIException - Thrown when the service provider returns an error.

getNameComponents

public java.lang.String[] getNameComponents(ObjectEntry oe)

Parses an object's full name into components.

The first element is the leaf object. The remaining elements in the array are the hierarchy of the leaf's parent object.

An NDAP namespace returns typeless names, for example: "bob" "Sales" "Novell"

An LDAP namespace returns typed names, for example : "cn=bob" "ou=Sales" "o=Novell"

Parameters:

oe - The object entry.

Returns:

A String array of relative distinguished names.

getObjectEffectiveRights

public Rights getObjectEffectiveRights(ObjectEntry objForInquire,
                                       ObjectEntry trustee)
                                throws SPIException

Returns the effective rights of an object to a target object.

Parameters:

objForInquire - The target object.

trustee - The trustee for the target object.

Returns:

The trustee's effective rights.

Throws:

SPIException - Thrown when the service provider returns an error.

getObjectEntry

public ObjectEntry getObjectEntry(ObjectEntry parentEntry,
                                  java.lang.String objEntryStr)
                           throws SPIException

Returns an ObjectEntry for a valid object name.

The object must exist in the namespace, or this method will fail.

Specified by:

NamespaceSnapinRev2 in interface NamespaceSnapinRev2

Parameters:

parentEntry - The parent ObjectEntry of the object being retrieved.

objEntryStr - A String representing the name of the child object.

Returns:

The ObjectEntry.

Throws:

SPIException - Refer to SPIException documentation.

getObjectEntry

public ObjectEntry getObjectEntry(java.lang.String objEntryStr)
                           throws SPIException

Returns an ObjectEntry for a valid object name.

The object must exist in the namespace, or this method will fail.

Specified by:

getObjectEntry in interface NamespaceSnapin

Parameters:

objEntryStr - A String representing the full name of an existing object.

Returns:

The ObjectEntry associated with the object name.

Throws:

SPIException - Thrown when the service provider returns an error.

getObjectType

public ObjectType getObjectType(ObjectEntry obj,
                                java.lang.String className)
                         throws SPIException

Returns an object type for the given object entry.

Parameters:

obj - The context for which to get the object type.

className - The name of the class for which to get the object type.

Returns:

The object types for this namespace.

Throws:

SPIException - Thrown when the service provider returns an error.

getObjectType

public ObjectType[] getObjectType(ObjectEntry tree,
                                  java.lang.String[] objectFDN)
                           throws SPIException

Get an ObjectType for each object FDN.

Parameters:

tree - An object entry for the tree containing the object FDN's.

objectFDN - An array of object FDN's.

Returns:

An array of ObjectType's.

Throws:

SPIException - see documentation.

getObjectTypes

public ObjectType[] getObjectTypes(ObjectEntry obj)
                            throws SPIException

Returns all of the possible object types for this namespace.

Specified by:

getObjectTypes in interface NamespaceSnapin

Parameters:

obj - The context in the namespace from which to get the object types.

Returns:

The object types for this namespace.

Throws:

SPIException - Thrown when the service provider returns an error.

See Also:

ObjectType

getPropertyEffectiveRights

public Rights[] getPropertyEffectiveRights(ObjectEntry objForInquire,
                                           ObjectEntry trustee,
                                           java.lang.String[] attrNames)
                                    throws SPIException

Returns the effective rights of an object to a target object's attributes.

Parameters:

objForInquire - The target object whose attributes are being checked.

trustee - The trustee for the target object.

attrNames - The names of the attributes on the target object.

Returns:

The object effective rights for each attribute.

Throws:

SPIException - Thrown when the service provider returns an error.

getSchemaDefinition

public SchemaDefinition getSchemaDefinition(ObjectEntry ctxObj)
                                     throws SPIException

Returns the schema definition from a given context.

Parameters:

ctxObj - The context from which the schema definition is being retrieved.

Returns:

The schema definition.

Throws:

SPIException - if an error occures in the SPI layer.

move

public ObjectEntry move(ObjectEntry objToMove,
                        ObjectEntry destination)
                 throws SPIException,
                        SnapinVetoException

Moves an object to another location in the namespace.

Parameters:

objToMove - The object to move.

destination - The destination location.

Returns:

The ObjectEntry for the object in the new location.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the move.

rename

public ObjectEntry rename(ObjectEntry fromObjEntry,
                          java.lang.String newName)
                   throws SPIException,
                          SnapinVetoException

Renames an object.

Parameters:

fromObjEntry - The object to rename.

newName - The new name for the object.

Returns:

The ObjectEntry of the renamed object.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the rename.

setAttribute

public void setAttribute(ObjectEntry obj,
                         ObjectAttribute attribute)
                  throws SPIException

Set the attribute value for a namespace objects particular attribute.

Parameters:

obj - The object that contains the attribute.

attribute - The attribute to set.

Throws:

SPIException - Refer to SPIException documentation.

setAttributes

public void setAttributes(ObjectEntry obj,
                          ObjectAttribute[] attributes)
                   throws SPIException

Writes attributes, including values, to an existing object.

Parameters:

obj - The object to which the attributes are being written.

attributes - The attributes being written.

Throws:

SPIException - Refer to SPIException documentation.

update

public void update(NSObject obj)
            throws SPIException,
                   SnapinVetoException

Writes object changes to the namespace.

Parameters:

obj - The namespace object being updated.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the update.