com.novell.admin.ns.nds
Interface NDSNamespace

All Superinterfaces:

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

public interface NDSNamespace

extends AdminNamespace, AuthenticationNamespace, MultiObjModificationNamespace, PartitionableNamespace

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

Field Summary

static java.lang.String

name The name of the namespace.

Method Summary

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.
ObjectAttribute[]	getAttributes(ObjectEntry obj, java.lang.String[] attrStrings, ObjectEntry serverObj) Reads an existing object in the namespace and returns an array containing the object's attributes, including their values.
ObjectEntryEnumeration	getChildContainers(ObjectEntry parent, ResultModifier modifiers) Retrieves the child container objects for a given container object.
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.
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.
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	update(NSObject obj, ObjectEntry serverObj) Writes object changes to the namespace.

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

compareAttribute, create, createNSObject, createNSObject, createNSObject, createObjectEntry, delete, deleteAttributeValues, doesExist, freeDetails, getAttribute, getAttributeDefinition, getAttributes, getChildren, getChildren, getClassDefinition, getContext, getCreationTime, getDetails, getDetails, getFullName, getFullyTypedName, getLastModificationTime, getMaxNameLength, getNameComponents, getObjectEffectiveRights, getObjectEntry, getObjectEntry, getObjectType, getObjectType, getObjectTypes, getPropertyEffectiveRights, getSchemaDefinition, move, 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, unAuthenticate, unAuthenticate

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

getMODDetails, updateMultipleObjects

Field Detail

name

public static final java.lang.String name

The name of the namespace.

This is used to register ConsoleOne snapins.

Method Detail

create

public 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

public 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

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

getAttributes

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

Reads an existing object in the namespace and returns an array containing the object's attributes, including their values. Directed read to server passed in.

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.

getChildContainers

public 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

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

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

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.

getDetails

public 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 for which to return the NSObject.

Returns:

The NSObject for the namespace object.

Throws:

SPIException - Thrown when the service provider returns an error.

getNCPExtension

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

getPartitionService

public 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

getPropertyEffectiveRights

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

getTreeNameFromServer

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

isServerUp

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

isSkadsServer

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

ncpFragmentRequest

public 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

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