com.novell.admin.ns

Interface AdminNamespace

All Superinterfaces:

AuthenticationNamespace, DeferParentNamespace, NamespaceSnapin, NamespaceSnapinRev2, Snapin

All Known Subinterfaces:

LDAPNamespace, NDSNamespace

public interface AdminNamespace
extends NamespaceSnapin, NamespaceSnapinRev2, DeferParentNamespace, AuthenticationNamespace

This interface describes a namespace service for object administration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_POST_NOTIFICATION
static int	EVENT_PRE_NOTIFICATION
static int	GETATTR_CONTEXTSTATICVALUES
static int	GETATTR_READFROMWRITABLEREPLICA
static int	GETATTR_USEEXCEPTIONREFERENCE

Method Summary

Modifier and Type	Method and Description
void	addDirectoryEventListener(com.novell.admin.event.DirectoryEventListener listener, int operation, java.lang.String objectType) This method is used to add directory event listeners to the namespace implementation.
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.
SPIException	createSPIException(int errCode)
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.
ObjectAttribute[]	getAttributes(ObjectEntry obj, java.lang.String[] attrStrings, int getAttrFlags, AdminNamespaceExceptionReference aneRef, ObjectEntry serverOE)
ObjectAttribute[]	getAttributes(ObjectEntry obj, java.lang.String[] attrStrings, int getAttrFlags, ObjectEntry serverOE)
ObjectAttribute[]	getAttributes(ObjectEntry obj, java.lang.String[] attrStrings, ObjectEntry serverOE) Reads an existing object in the namespace and returns an array containing the object's attributes, including their values.
java.lang.String[]	getAttributesPresent(ObjectEntry useOE, java.lang.String[] attributeNames) This method takes in an ObjectEntry and a array of attributes and returns an array of only those attributes which are present for the ObjectEntry.This only returns the names of existing attributes not 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	getDelayedAttibuteDetails(ObjectEntry objEntry, java.lang.String[] delayedAttrStrings)
NSObject	getDelayedAttibuteDetails(ObjectEntry objEntry, java.lang.String[] delayedAttrStrings, ObjectEntry serverOE)
java.lang.String	getDereferencedAliasObjectDN(ObjectEntry oe) Retrieves the DN of the object the alias is pointing to.
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.
java.util.Map<java.lang.String,NDSPropertyRights>	getOrderedPropertyEffectiveRights(ObjectEntry objForInquire, ObjectEntry trustee, java.lang.String[] attrNames) Reads the details for an existing object and returns an NSObject for that object.
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.
boolean	isSupported(java.lang.String key) Determines if a particular feature is supported on this platform.
boolean	isSupported(java.lang.String key, java.lang.Object param) Determines if a particular feature is supported on this platform.
boolean	isSupported(java.lang.String key, java.lang.Object param, ObjectEntry oe) Determines if a particular feature is supported on this platform. Features are identified by a key and an optional parameter. This method has an ObjectEntry parameter from which to obtain the schema definition to use.
ObjectEntry	move(ObjectEntry objToMove, ObjectEntry destination) Moves an object to another location in the namespace.
void	removeDirectoryEventListener(com.novell.admin.event.DirectoryEventListener listener) This method is used to remove directory event listeners from the namespace implementation.
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

Methods inherited from interface com.novell.admin.ns.AuthenticationNamespace

authenticate, authenticate, authenticateServer, changePassword, changePassword, getAuthenticatedIdentity, getLoginCache, setPassword, setPassword, setPassword, unAuthenticate, unAuthenticate

Field Detail

GETATTR_CONTEXTSTATICVALUES

static final int GETATTR_CONTEXTSTATICVALUES

See Also:

Constant Field Values

GETATTR_READFROMWRITABLEREPLICA

static final int GETATTR_READFROMWRITABLEREPLICA

See Also:

Constant Field Values

GETATTR_USEEXCEPTIONREFERENCE

static final int GETATTR_USEEXCEPTIONREFERENCE

See Also:

Constant Field Values

EVENT_PRE_NOTIFICATION

static final int EVENT_PRE_NOTIFICATION

See Also:

Constant Field Values

EVENT_POST_NOTIFICATION

static final int EVENT_POST_NOTIFICATION

See Also:

Constant Field Values

Method Detail

create

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

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

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.

createNSObject

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.

createObjectEntry

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

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.

doesExist

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.

getMaxNameLength

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.

getContext

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.

getObjectType

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.

getNameComponents

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.

getAttribute

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.

setAttribute

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.

getObjectTypes

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

getObjectType

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.

getAttributes

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 to obtain attributes for.

attrStrings - The object attributes to obtain, null for all attributes.

Returns:

An array of ObjectAttribute which may contain null at the index where attrStrings has an invalid attribute name for the object.

Throws:

SPIException - Thrown when the service provider returns an error. Refer to SPIException documentation.

NamespaceException

getAttributes

ObjectAttribute[] getAttributes(ObjectEntry obj,
                                java.lang.String[] attrStrings,
                                ObjectEntry serverOE)
                         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 to obtain attributes for.

attrStrings - The object attributes to obtain, null for all attributes.

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

Returns:

An array of ObjectAttribute which may contain null at the index where attrStrings has an invalid attribute name for the object.

Throws:

SPIException - Thrown when the service provider returns an error.

NamespaceException

getAttributes

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

Parameters:

obj - The object to obtain attributes for.

attrStrings - The object attributes to obtain, null for all attributes.

getAttrFlags - 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.

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

Returns:

An array of ObjectAttribute which may contain null at the index where attrStrings has an invalid attribute name for the object.

Throws:

SPIException - may be thrown

NamespaceException - NamespaceException.UNSUPPORTED_OPERATION will be thrown if the namespace does not support the specific mode.

getAttributes

ObjectAttribute[] getAttributes(ObjectEntry obj,
                                java.lang.String[] attrStrings,
                                int getAttrFlags,
                                AdminNamespaceExceptionReference aneRef,
                                ObjectEntry serverOE)
                         throws SPIException,
                                NamespaceException

Parameters:

obj - The object to obtain attributes for.

attrStrings - The object attributes to obtain, null for all attributes.

getAttrFlags - 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 - an AdminNamespaceExceptionReference which may contain an AdminNamespaceException. If this parameter is NOT null, then any Exception that occured will be returned in this object and will NOT be thrown. It will still return an ObjectAttribute[] which may or may not have values depending on what was read. If no error occurs then this will contain null. This is useful with the USEEXCEPTIONREFERENCE flag which allows dynamic group members to return partitial results. This is for Exceptions. Any Errors (AdminError) may still be thrown.

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

Returns:

An array of ObjectAttribute which may contain null at the index where attrStrings has an invalid attribute name for the object.

Throws:

SPIException - may be thrown

NamespaceException - NamespaceException.UNSUPPORTED_OPERATION will be thrown if the namespace does not support the specific mode.

setAttributes

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.

getClassDefinition

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.

getAttributeDefinition

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.

getSchemaDefinition

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.

getChildren

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

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

getObjectEffectiveRights

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.

getPropertyEffectiveRights

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.

getOrderedPropertyEffectiveRights

java.util.Map<java.lang.String,NDSPropertyRights> getOrderedPropertyEffectiveRights(ObjectEntry objForInquire,
                                                                                    ObjectEntry trustee,
                                                                                    java.lang.String[] attrNames)
                                                                             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

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.

getDelayedAttibuteDetails

NSObject getDelayedAttibuteDetails(ObjectEntry objEntry,
                                   java.lang.String[] delayedAttrStrings)
                            throws SPIException

Parameters:

objEntry - The ObjectEntry object to get details for.

delayedAttrStrings - array of attribute names to delay the reading of. This should not be null - if there are no attributes to be delayed getDetails() should be used.

Returns:

NSObject which contains details on the object.

Throws:

SPIException - Refer to SPIException documentation.

getDelayedAttibuteDetails

NSObject getDelayedAttibuteDetails(ObjectEntry objEntry,
                                   java.lang.String[] delayedAttrStrings,
                                   ObjectEntry serverOE)
                            throws SPIException

Parameters:

objEntry - The ObjectEntry object to get details for.

delayedAttrStrings - array of attribute names to delay the reading of. This should not be null - if there are no attributes to be delayed getDetails() should be used.

serverOE - the server to read the object information from for the current attributes being read. However, reading the delayed attributes will not be directed.

Returns:

NSObject which contains details on the object.

Throws:

SPIException - Refer to SPIException documentation.

getDetails

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.

getDereferencedAliasObjectDN

java.lang.String getDereferencedAliasObjectDN(ObjectEntry oe)
                                       throws SPIException

Retrieves the DN of the object the alias is pointing to.

Parameters:

oe - The ObjectEntry of the dereferenced alias.

Returns:

Returns the DN of the object the alias points to.

Throws:

SPIException - Thrown by the service provider.

freeDetails

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.

getFullName

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.

getObjectEntry

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.

getObjectEntry

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:

getObjectEntry 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.

move

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

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.

update

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.

getFullyTypedName

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

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.

getCreationTime

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.

compareAttribute

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.

deleteAttributeValues

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.

isSupported

boolean isSupported(java.lang.String key)
             throws NamespaceException,
                    SPIException

Determines if a particular feature is supported on this platform.
Features are identified by a key and an optional parameter. Use the isSupported(key,param) method when a parameter is required. Keys and parameters are case-insensitive and are chosen from the following list:

• Class <>
• Attr <>
• Control <>
• Extension <>
• NVDS (no parameter)
• eDir (no parameter)

The keys 'attribute' and 'eDirectory' may also be used for 'Attr' and 'eDir'. Classes and attributes may be queried by name or by OID. Case is insignificant. The 'NVDS' and 'eDir' keys return true if the platform is an NVDS or eDirectory respectively. Whenever possible, one should use one of the other keys to discover the particular feature in question rather than just NVDS vs eDir, since these designations become blurred as platforms evolve.

Parameters:

key - A String indicating the feature being queried.

Returns:

true if the feature is supported by this platform.

Throws:

NamespaceException - Thrown when the namespace detects an error. Not currently used.

SPIException - Thrown when the service provider returns an error. Not currently used.

isSupported

boolean isSupported(java.lang.String key,
                    java.lang.Object param)
             throws NamespaceException,
                    SPIException

Determines if a particular feature is supported on this platform.
Features are identified by a key and an optional parameter. Keys and parameters are case-insensitive and are chosen from the following list:

• Class <>
• Attr <>
• Control <>
• Extension <>
• NVDS (no parameter)
• eDir (no parameter)

The keys 'attribute' and 'eDirectory' may also be used for 'Attr' and 'eDir'. Classes and attributes may be queried by name or by OID. Case is insignificant. The 'NVDS' and 'eDir' keys return true if the platform is an NVDS or eDirectory respectively. Whenever possible, one should use one of the other keys to discover the particular feature in question rather than just NVDS vs eDir, since these designations become blurred as platforms evolve.

Parameters:

key - A String indicating the feature being queried.

param - The parameter required by some keys.

Returns:

true if the feature is supported by this platform.

Throws:

NamespaceException - Thrown when the namespace detects an error. Not currently used.

SPIException - Thrown when the service provider returns an error. Not currently used.

isSupported

boolean isSupported(java.lang.String key,
                    java.lang.Object param,
                    ObjectEntry oe)
             throws NamespaceException,
                    SPIException

Determines if a particular feature is supported on this platform.
Features are identified by a key and an optional parameter.
This method has an ObjectEntry parameter from which to obtain the schema definition to use. If null, it uses the schema obtained from the root DSE.
Keys and parameters are case-insensitive and are chosen from the following list:

• Class <>
• Attr <>
• Control <>
• Extension <>
• NVDS (no parameter)
• eDir (no parameter)

The keys 'attribute' and 'eDirectory' may also be used for 'Attr' and 'eDir'. Classes and attributes may be queried by name or by OID. Case is insignificant. The 'NVDS' and 'eDir' keys return true if the platform is NVDS or eDirectory respectively. Whenever possible, one should use one of the other keys to discover the particular feature in question rather than just NVDS vs eDir, since these designations may become blurred as platforms evolve.

Parameters:

key - A String indicating the feature being queried.

param - The parameter required by some keys.

oe - The ObjectEntry from which to obtain the schema definition.

Returns:

true if the feature is supported by this platform. false is returned if the key or parameter is not recognized.

Throws:

NamespaceException - Thrown when the namespace detects an error.
NamespaceException.INVALID_NAME is thrown if the key is null, or if a schema definition cannot be obtained.

SPIException - Thrown when the service provider returns an error. Not currently used.

createSPIException

SPIException createSPIException(int errCode)

addDirectoryEventListener

void addDirectoryEventListener(com.novell.admin.event.DirectoryEventListener listener,
                               int operation,
                               java.lang.String objectType)

This method is used to add directory event listeners to the namespace implementation. Any listeners that are added will be notified when a directory event occurs.

Parameters:

listener - - The listener to add

operation - - The operation that is being performed

objectType - - The type of the object the operation is being performed on. * to the namespace, so that DirectoryEventListeners can get authentication specific data.

removeDirectoryEventListener

void removeDirectoryEventListener(com.novell.admin.event.DirectoryEventListener listener)

This method is used to remove directory event listeners from the namespace implementation.

Parameters:

listener - - The listener to remove

getAttributesPresent

java.lang.String[] getAttributesPresent(ObjectEntry useOE,
                                        java.lang.String[] attributeNames)
                                 throws SPIException

This method takes in an ObjectEntry and a array of attributes and returns an array of only those attributes which are present for the ObjectEntry.This only returns the names of existing attributes not their values.

Parameters:

useOE, - ObjectEntry of the object.

attributeNames, - the array of attributes to be checked for existence.if this is null then names of all the existing attributes will be returned.

Returns:

an array of attributes(Subset of attributeNames) which are present for the Object. if no attribute in attributeNames is present for the Object then this will be null.

Throws:

SPIException