com.novell.admin.ns.nds

Interface NDSNamespace

All Superinterfaces:

AdminNamespace, AuthenticationNamespace, DeferParentNamespace, MultiObjModificationNamespace, NamespaceSnapin, NamespaceSnapinRev2, PartitionableNamespace, Snapin

public interface NDSNamespace
extends AdminNamespace, MultiObjModificationNamespace, PartitionableNamespace

This class provides the ability to manage a Novell Directory Service Namespace.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCESSMASTER
static int	ACCESSNORMAL
static int	ALIASDEREFERENCEDISABLE
static int	ALIASDEREFERENCENORMAL
static java.lang.String	name The name of the namespace.

Fields inherited from interface com.novell.admin.ns.AdminNamespace

EVENT_POST_NOTIFICATION, EVENT_PRE_NOTIFICATION, GETATTR_CONTEXTSTATICVALUES, GETATTR_READFROMWRITABLEREPLICA, GETATTR_USEEXCEPTIONREFERENCE

Method Summary

Modifier and Type	Method and Description
void	create(NSObject obj, ObjectEntry serverObj) Creates a new object in the namespace.
void	delete(ObjectEntry obj, ObjectEntry serverObj) Deletes an object from the namespace.
java.lang.String	escapeTheRDNDot(java.lang.String rdn) Will place an escape character '\' in front of any unescaped dot '.' characters in the String passed in.
void	freeObjectEntryEnumeration(ObjectEntryEnumeration oeEnum)
int	getAccessConfidence()
int	getAliasDereference()
ObjectEntryEnumeration	getChildContainers(ObjectEntry parent, ResultModifier modifiers) Retrieves the child container objects for a given container object.
java.lang.String	getDefaultIpAddress(ObjectEntry useOE)
int	getDefaultIpPort(ObjectEntry useOE)
java.lang.String	getDefaultServerDN(ObjectEntry useOE)
boolean	getDefinedMethod(java.lang.String methodName, java.lang.Class[] parameters) This method search for a method in the jClient API.If the method doesn't exist, it throws an NoSuchMethodException.To use this method AdminNameSpace Object should be down-casted to NDSNameSpace.
java.lang.String	getDereferencedAliasObjectDN(ObjectEntry aliasOE) Retrieves the DN of the object the alias is pointing to.
NSObject	getDetails(ObjectEntry obj, ObjectEntry serverObj) Reads the details for an existing object and returns an NSObject for that object.
java.lang.String[]	getFileSystemAndDirectoryElements(java.lang.String nameToParse) Get Strings for the eDir portions and filesystem portions of the name The filesystem portions would have to have both BEGIN & END FEDERATED tags in order to be correctly parsed off.
ObjectEntry	getFileSystemObjectEntry(java.lang.String DirectoryStr, java.lang.String FileSystemStr) Returns an ObjectEntry representation of the FileSystem object for the Strings passed in.
NScache	getLoginCache() This method is to get the Cache in form of a HashTable to be used in framework to write to the filesystem.
java.lang.String	getNamespaceVersion()
NDSNCPExtension	getNCPExtension(java.lang.String name, ObjectEntry serverOE) Helper method to the ncp extension device.
PartitionService	getPartitionService(ObjectEntry obj) Returns the handle to the partition management service.
Rights	getPropertyEffectiveRights(ObjectEntry objForInquire, ObjectEntry trustee, java.lang.String attrName) Get the effective property rights of a trustee on an objects attribute.
java.lang.String	getTreeNameFromServer(java.lang.String server) Get the tree name from a specified server.
java.lang.String[]	getVolumesOnServer(ObjectEntry serverOE) This method is to get all the volumes that are mounted on this NCP Server
boolean	isFileSystemObject(java.lang.String nameToCheck) Returns whether the name contains a FileSystem portion or just an NDS portion.
boolean	isServerUp(ObjectEntry obj) Determines whether or not the particular server is up.
boolean	isSkadsServer(ObjectEntry obj) Determines whether or not the object is in an NDS v8 tree.
int	ncpFragmentRequest(ObjectEntry oe, int ncp, int verb, byte[][] requestFrags, byte[][] replyFrags) Send NCP using a fragmented request
void	setAccessConfidence(int newConfidence)
void	setAliasDereference(int newDereference)
void	update(NSObject obj, ObjectEntry serverObj) Writes object changes to the namespace.

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

addDirectoryEventListener, compareAttribute, create, createNSObject, createNSObject, createNSObject, createObjectEntry, createSPIException, delete, deleteAttributeValues, doesExist, freeDetails, getAttribute, getAttributeDefinition, getAttributes, getAttributes, getAttributes, getAttributes, getAttributesPresent, getChildren, getChildren, getClassDefinition, getContext, getCreationTime, getDelayedAttibuteDetails, getDelayedAttibuteDetails, getDetails, getDetails, getFullName, getFullyTypedName, getLastModificationTime, getMaxNameLength, getNameComponents, getObjectEffectiveRights, getObjectEntry, getObjectEntry, getObjectType, getObjectType, getObjectTypes, getOrderedPropertyEffectiveRights, getPropertyEffectiveRights, getSchemaDefinition, isSupported, isSupported, isSupported, move, removeDirectoryEventListener, rename, setAttribute, setAttributes, update

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

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, setPassword, setPassword, setPassword, unAuthenticate, unAuthenticate

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

getMODDetails, updateMultipleObjects

Field Detail

name

static final java.lang.String name

The name of the namespace.

This is used to register ConsoleOne snapins.

ACCESSNORMAL

static final int ACCESSNORMAL

See Also:

Constant Field Values

ACCESSMASTER

static final int ACCESSMASTER

See Also:

Constant Field Values

ALIASDEREFERENCENORMAL

static final int ALIASDEREFERENCENORMAL

See Also:

Constant Field Values

ALIASDEREFERENCEDISABLE

static final int ALIASDEREFERENCEDISABLE

See Also:

Constant Field Values

Method Detail

getChildContainers

ObjectEntryEnumeration getChildContainers(ObjectEntry parent,
                                          ResultModifier modifiers)
                                   throws SPIException

Retrieves the child container objects for a given container object.

Volume and server leaf objects are also returned. This method is typically used in providing a tree view. Note - Notification is not made when a partial list is returned.

Specified by:

getChildContainers in interface NamespaceSnapin

Parameters:

parent - The parent object as an ObjectEntry.

modifiers - Determines how the child list is built.

Returns:

Returns an enumeration of the children.

Throws:

SPIException - Thrown by the service provider.

See Also:

ObjectEntryEnumeration

getDereferencedAliasObjectDN

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

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

Specified by:

getDereferencedAliasObjectDN in interface AdminNamespace

Parameters:

aliasOE - The ObjectEntry of the alias.

Returns:

Returns the DN of the object the alias points to.

Throws:

SPIException - Thrown by the service provider.

getPartitionService

PartitionService getPartitionService(ObjectEntry obj)
                              throws SPIException

Returns the handle to the partition management service.

Specified by:

getPartitionService in interface PartitionableNamespace

Parameters:

obj - The context at which to manage.

Returns:

The partition management service.

Throws:

SPIException - Thrown by the service provider.

See Also:

PartitionService

isSkadsServer

boolean isSkadsServer(ObjectEntry obj)
               throws SPIException

Determines whether or not the object is in an NDS v8 tree.

Parameters:

obj - The object.

Returns:

True if object is in an NDS v8 tree, false otherwise.

Throws:

SPIException - Thrown by the service provider.

isServerUp

boolean isServerUp(ObjectEntry obj)

Determines whether or not the particular server is up.

Parameters:

obj - The server object.

Returns:

True if the server is up, false otherwise.

getNCPExtension

NDSNCPExtension getNCPExtension(java.lang.String name,
                                ObjectEntry serverOE)
                         throws SPIException

Helper method to the ncp extension device.

Parameters:

name - The name of the ncp extension on the file server

serverOE - The server where the ncp extension resides

Returns:

The ncp extension service.

Throws:

SPIException - Refer to SPIException documentation.

getDetails

NSObject getDetails(ObjectEntry obj,
                    ObjectEntry serverObj)
             throws SPIException

Reads the details for an existing object and returns an NSObject for that object. Performs a directed read.

Parameters:

obj - The ObjectEntry object to get details for.

serverObj - the server to read the object information from

Returns:

NSObject which contains details on the object.

Throws:

SPIException - Refer to SPIException documentation.

getTreeNameFromServer

java.lang.String getTreeNameFromServer(java.lang.String server)
                                throws SPIException

Get the tree name from a specified server.

Parameters:

server - The server.

Returns:

The tree name.

Throws:

SPIException - Refer to SPIException documentation.

getPropertyEffectiveRights

Rights getPropertyEffectiveRights(ObjectEntry objForInquire,
                                  ObjectEntry trustee,
                                  java.lang.String attrName)
                           throws SPIException

Get the effective property rights of a trustee on an objects attribute.

Parameters:

objForInquire - The object.

trustee - The trustee.

attrName - The attribute.

Returns:

The effective rights.

Throws:

SPIException - Refer to SPIException documentation.

ncpFragmentRequest

int ncpFragmentRequest(ObjectEntry oe,
                       int ncp,
                       int verb,
                       byte[][] requestFrags,
                       byte[][] replyFrags)
                throws SPIException

Send NCP using a fragmented request

Parameters:

oe - The server oe to send the request to.

ncp - The NCP number.

verb - The NCP verb number.

requestFrags - The fragments to send to the server.

replyFrags - The fragments to fill in with the responce from the server.

Returns:

The number of bytes received in the reply fragment.

Throws:

SPIException - Refer to SPIException documentation.

update

void update(NSObject obj,
            ObjectEntry serverObj)
     throws SPIException,
            SnapinVetoException

Writes object changes to the namespace. Directed write to a server.

Parameters:

obj - The namespace object being updated.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the update.

create

void create(NSObject obj,
            ObjectEntry serverObj)
     throws SPIException,
            SnapinVetoException

Creates a new object in the namespace. Directed write to a server.

Parameters:

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

serverObj - The server to direct the create operation to.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the create.

delete

void delete(ObjectEntry obj,
            ObjectEntry serverObj)
     throws SPIException,
            SnapinVetoException

Deletes an object from the namespace. Directed write to a server.

Parameters:

obj - The object entry representing the object to delete.

serverObj - The server to direct the delete operation to.

Throws:

SPIException - Thrown when the service provider returns an error.

SnapinVetoException - Another snapin has disallowed the delete.

escapeTheRDNDot

java.lang.String escapeTheRDNDot(java.lang.String rdn)

Will place an escape character '\' in front of any unescaped dot '.' characters in the String passed in. The purpose of this routine is to allow a user to type in an NDS name that contains dots without having to escape them at the time of entry. This will facilitate names such as "user@novell.com". Although this is not a valid NDS name, we want the user to be able to create and rename NDS objects with this type of name without having to type "user@novell\.com".

Parameters:

rdn - The String object being updated.

getAccessConfidence

int getAccessConfidence()
                 throws NamespaceException

Throws:

NamespaceException

setAccessConfidence

void setAccessConfidence(int newConfidence)
                  throws NamespaceException,
                         SPIException

Throws:

NamespaceException

SPIException

getAliasDereference

int getAliasDereference()
                 throws NamespaceException

Throws:

NamespaceException

setAliasDereference

void setAliasDereference(int newDereference)
                  throws NamespaceException

Throws:

NamespaceException

getNamespaceVersion

java.lang.String getNamespaceVersion()

freeObjectEntryEnumeration

void freeObjectEntryEnumeration(ObjectEntryEnumeration oeEnum)
                         throws SPIException

Throws:

SPIException

getDefaultIpAddress

java.lang.String getDefaultIpAddress(ObjectEntry useOE)
                              throws SPIException

Parameters:

useOE - - oe to determine the tree to return information on

Throws:

SPIException - - failed, information is not avaliable

getDefaultIpPort

int getDefaultIpPort(ObjectEntry useOE)
              throws SPIException

Parameters:

useOE - - oe to determine the tree to return information on

Throws:

SPIException - - failed, information is not avaliable

getDefaultServerDN

java.lang.String getDefaultServerDN(ObjectEntry useOE)
                             throws SPIException

Parameters:

useOE - - oe to determine the tree to return information on

Throws:

SPIException - - failed, information is not avaliable

isFileSystemObject

boolean isFileSystemObject(java.lang.String nameToCheck)
                    throws SPIException

Returns whether the name contains a FileSystem portion or just an NDS portion. (The user should not know about specific FS_FEDERATED tags that may change)

Parameters:

nameToCheck - full name representing the object Example: "admin.provo.novell" or "admin.provo.novell.tree." Example: "\\Server\Volid:dir\file.volume.provo.novell.tree."

Returns:

true or false

Throws:

SPIException

getFileSystemAndDirectoryElements

java.lang.String[] getFileSystemAndDirectoryElements(java.lang.String nameToParse)
                                              throws SPIException

Get Strings for the eDir portions and filesystem portions of the name The filesystem portions would have to have both BEGIN & END FEDERATED tags in order to be correctly parsed off. The FEDERATED tags will not be returned as part of the parsed values. This does not have to be a full DN in the eDir system. It may only be a filesystemname with tags or a combination of filesystem names and partitial eDir name

Parameters:

nameToParse - full name with FileSystem and Directory portions (The user should not know about specific FS_FEDERATED tags that may change)

Returns:

a String array where arr[0] (String) the NDS portion of the name - null if not there arr[1] (String) the file system portion of the name without the FEDERATED tags - null if no filessystem part Example: "admin.provo.novell" or "admin.provo.novell.tree." [0] = "admin.provo.novell" or "admin.provo.novell.tree." [1] = null Example: "\\Server\Volid:dir\file.volume.provo.novell.tree." (again the trailing .tree. is optional) [0] = "volume.provo.novell.tree." [1] = "\\Server\Volid:dir\file" Example: "\\Server\Volid:dir\file.volume.provo" [0] = "volume.provo" [1] = "\\Server\Volid:dir\file" Example: "\\Server\Volid:dir\file" (again the trailing .tree. is optional) [0] = null [1] = "\\Server\Volid:dir\file"

Throws:

SPIException

getFileSystemObjectEntry

ObjectEntry getFileSystemObjectEntry(java.lang.String DirectoryStr,
                                     java.lang.String FileSystemStr)
                              throws SPIException

Returns an ObjectEntry representation of the FileSystem object for the Strings passed in. This must be a full string representation of the Directory object and the FileSystem object (see example below)

Parameters:

DirectoryStr - FDN for an object with the tree. The may also work without the tree Example: "admin.provo.novell.tree."

FileSystemStr - Fully qualified file system object. This may be null. (The user should not know about specific FS_FEDERATED tags that may change) This may not have any FS_FEDERATED tags for going into the FileSytem Example: "\\Server\Volid:dir\file"

Returns:

Throws:

SPIException

getDefinedMethod

boolean getDefinedMethod(java.lang.String methodName,
                         java.lang.Class[] parameters)

This method search for a method in the jClient API.If the method doesn't exist, it throws an NoSuchMethodException.To use this method AdminNameSpace Object should be down-casted to NDSNameSpace.

Parameters:

methodName - - to search in the API

parameters - - Parameters that passes to the method.

Returns:

- true/fase depending on the method is exist or not.

getVolumesOnServer

java.lang.String[] getVolumesOnServer(ObjectEntry serverOE)
                               throws SPIException

This method is to get all the volumes that are mounted on this NCP Server

Parameters:

serverOE - - a valid NCP Server Object Entry

Returns:

a String array containing an entry for each volume name currently mounted on this server. This may be a 0 length array, but will not be null.

Throws:

SPIException

getLoginCache

NScache getLoginCache()

This method is to get the Cache in form of a HashTable to be used in framework to write to the filesystem. This Cache is created to cache the Tree name and the respective ip address for the tree name.

Specified by:

getLoginCache in interface AuthenticationNamespace