com.novell.admin.ns.nw
Class NetWareNamespace

java.lang.Object
  |
  +--com.novell.admin.ns.nw.NetWareNamespace

All Implemented Interfaces:

NamespaceSnapin, Snapin

public abstract class NetWareNamespace

extends java.lang.Object

implements NamespaceSnapin,

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

Inner Class Summary

class

NetWareNamespace.NetWareObjectEntryEnumeration This class provides the utility to enumerate over an object children.

Field Summary

static java.lang.String	name The name of the namespace.
protected SimpleSPIException	nsSpiException
protected java.util.Hashtable	otTable
protected java.lang.String	TREE_SEPARATOR

Constructor Summary

NetWareNamespace(java.lang.String separator)
Constructor.

Method Summary

ObjectEntry	createObjectEntry(ObjectEntry parent, java.lang.String child, java.lang.String className) Create an ObjectEntry for a child.
ObjectEntryEnumeration	getChildContainers(ObjectEntry parent, ResultModifier modifier) Gets the subordinate objects from an ObjectEntry.
NSObject	getDetails(ObjectEntry objEntry) Returns a NSObject from an ObjectEntry.
java.lang.String	getFullName(ObjectEntry obj) Returns the full name of the objectEntry.
ObjectEntry[]	getInitialObjectEntries() Gets the root object entry.
ObjectEntry[]	getInitialObjectEntries(ObjectEntry oe, context)
ObjectEntry	getObjectEntry(ObjectEntry parentObjEntry, java.lang.String child) Returns an ObjectEntry representation of the String passed in.
ObjectEntry	getObjectEntry(java.lang.String objEntryStr) Returns an ObjectEntry representation of the tree of the string passed in.
ObjectType[]	getObjectTypes(ObjectEntry entry) Returns all of the posible object types for this namespace.
java.lang.String	getSnapinDescription() This is used by the shell to get the snapins description.
java.lang.String	getSnapinName() This is used by the shell to get the snapins name.
java.lang.String	getUniqueID() Returns the namespace name string.
java.lang.String	getUnrootedName(ObjectEntry obj) Gets the objects name not including the root portion.
boolean	initSnapin(InitSnapinInfo info) This is used by the shell to initialize the snapin.
protected SPIException	resolveSPIException(java.lang.Exception x) Converts an Exception into an SPIException.
void	shutdownSnapin() This is used by the shell to shut down the snapin.

Methods inherited from class java.lang.Object

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

Field Detail

name

public static final java.lang.String name

The name of the namespace.

TREE_SEPARATOR

protected java.lang.String TREE_SEPARATOR

otTable

protected final java.util.Hashtable otTable

nsSpiException

protected SimpleSPIException nsSpiException

Constructor Detail

NetWareNamespace

public NetWareNamespace(java.lang.String separator)

Constructor.

Method Detail

getSnapinName

public java.lang.String getSnapinName()

This is used by the shell to get the snapins name.

Returns:

The snapin name.

getSnapinDescription

public java.lang.String getSnapinDescription()

This is used by the shell to get the snapins description.

Returns:

The snapin description.

initSnapin

public boolean initSnapin(InitSnapinInfo info)

This is used by the shell to initialize the snapin.

Parameters:

info - - not used.

Returns:

true - snapin initialized successfully.

shutdownSnapin

public void shutdownSnapin()

This is used by the shell to shut down the snapin.

getInitialObjectEntries

public ObjectEntry[] getInitialObjectEntries(ObjectEntry oe,
                                              context)

Specified by:

getInitialObjectEntries in interface

getInitialObjectEntries

public ObjectEntry[] getInitialObjectEntries()

Gets the root object entry.

Specified by:

getInitialObjectEntries in interface NamespaceSnapin

Returns:

ObjectEntry array containing the object entry.

createObjectEntry

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

Create an ObjectEntry for a child.

Parameters:

parent - The ObjectEntry of the childs parent.

child - The name of the child.

className - Not used.

Returns:

The object entry for the child.

getObjectTypes

public ObjectType[] getObjectTypes(ObjectEntry entry)

Returns all of the posible object types for this namespace.

Specified by:

getObjectTypes in interface NamespaceSnapin

Returns:

the object types for this namespace.

getFullName

public java.lang.String getFullName(ObjectEntry obj)

Returns the full name of the objectEntry.

Specified by:

getFullName in interface NamespaceSnapin

Parameters:

obj - - The object to get the full name for.

Returns:

the full name of the object.

getChildContainers

public ObjectEntryEnumeration getChildContainers(ObjectEntry parent,
                                                 ResultModifier modifier)

Gets the subordinate objects from an ObjectEntry. \

There is never any child containers in this namespace.

Specified by:

getChildContainers in interface NamespaceSnapin

Parameters:

obj - The container to get children for.

modifiers - The modifiers for creating the list of children.

Returns:

An enumeration of the child objects found.

getUnrootedName

public java.lang.String getUnrootedName(ObjectEntry obj)

Gets the objects name not including the root portion.

Parameters:

obj - Object to get the unrooted name for.

Returns:

The fully distinguished name excluding the root name.

getDetails

public NSObject getDetails(ObjectEntry objEntry)

Returns a NSObject from an ObjectEntry.

Parameters:

objEntry - The ObjectEntry object to get details for.

Returns:

null

getUniqueID

public java.lang.String getUniqueID()

Returns the namespace name string.

Specified by:

getUniqueID in interface NamespaceSnapin

Returns:

the namespace string.

getObjectEntry

public ObjectEntry getObjectEntry(java.lang.String objEntryStr)

Returns an ObjectEntry representation of the tree of the string passed in.

Specified by:

getObjectEntry in interface NamespaceSnapin

Parameters:

objEntryStr - The name of the object.

Returns:

The ObjectEntry.

getObjectEntry

public ObjectEntry getObjectEntry(ObjectEntry parentObjEntry,
                                  java.lang.String child)

Returns an ObjectEntry representation of the String passed in.

Specified by:

getObjectEntry in interface

Parameters:

parentObjEntry - The parent object.

child - The childe of the parent.

Returns:

The ObjectEntry.

resolveSPIException

protected SPIException resolveSPIException(java.lang.Exception x)

Converts an Exception into an SPIException.

Parameters:

x - The exception to convert.

Returns:

The SPIException