com.novell.admin.ns.ldap

Interface LDAPNamespace

All Superinterfaces:

AdminNamespace, AuthenticationNamespace, DeferParentNamespace, LDAPAuthenticationNamespace, NamespaceSnapin, NamespaceSnapinRev2, Snapin

public interface LDAPNamespace
extends AdminNamespace, LDAPAuthenticationNamespace, NamespaceSnapin, NamespaceSnapinRev2

This class provides the utilities to specifically manage an LDAP Directory.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_EFFECTIVE_RIGHTS_REQ
static java.lang.String	INCLUDE_SUBENTRIES_CONTROL_ID
static java.lang.String	MANAGE_DSA_IT_CONTROL_ID
static java.lang.String	name
static java.lang.String	NVDS_EFFECTIVE_PRIVILEGES_CONTROL_ID
static java.lang.String	RESOLVE_ALIAS_CONTROL_ID

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
boolean	clearControl(java.lang.String controlOID) Clears the specified control on this context.
java.lang.String[]	getNamingContexts() Get the naming contexts on the current server.
ValueList[]	getNVDSEffectivePrivileges(ObjectEntry obj, boolean allLegalAttrs) NVDS-specific method to get effective rights of the logged-in user on an object.
ValueList[]	getNVDSEffectivePrivileges(ObjectEntry obj, java.lang.String[] attrs, java.lang.String[] classes) NVDS-specific method to get effective rights of the logged-in user on an object.
java.lang.String	getProviderURL() Returns the LDAP server's host name and port number to which this namespace is authenticated.
java.util.ArrayList	getSupportedControls() Returns a list of OIDs representing the LDAP controls supported by this server.
java.util.ArrayList	getSupportedExtensions() Returns a list of OIDs representing the LDAP extensions supported by this server.
boolean	isControlSet(java.lang.String controlOID) Tests whether a control is currently set on this context.
java.lang.String	sendXMLRequest(java.lang.String servicePath, java.lang.String xmlRequest) Sends an NVDS XML Payload Extension to the server
boolean	setControl(java.lang.String controlOID) Sets the spcified control on this context.

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, getDereferencedAliasObjectDN, 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

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

Methods inherited from interface com.novell.admin.ns.ldap.LDAPAuthenticationNamespace

authenticate, authenticate, authenticate, authenticateServer

Field Detail

name

static final java.lang.String name

MANAGE_DSA_IT_CONTROL_ID

static final java.lang.String MANAGE_DSA_IT_CONTROL_ID

See Also:

Constant Field Values

INCLUDE_SUBENTRIES_CONTROL_ID

static final java.lang.String INCLUDE_SUBENTRIES_CONTROL_ID

See Also:

Constant Field Values

RESOLVE_ALIAS_CONTROL_ID

static final java.lang.String RESOLVE_ALIAS_CONTROL_ID

See Also:

Constant Field Values

GET_EFFECTIVE_RIGHTS_REQ

static final java.lang.String GET_EFFECTIVE_RIGHTS_REQ

See Also:

Constant Field Values

NVDS_EFFECTIVE_PRIVILEGES_CONTROL_ID

static final java.lang.String NVDS_EFFECTIVE_PRIVILEGES_CONTROL_ID

See Also:

Constant Field Values

Method Detail

setControl

boolean setControl(java.lang.String controlOID)
            throws javax.naming.NamingException

Sets the spcified control on this context. All subsequent LDAP operations will have this control added. The controls allowed with this method have no data parameters to set. Criticality is set to false, meaning the server will ignore the control if it is not supported.
The following controls are valid:
MANAGE_DSA_IT_CONTROL_ID:
This control causes the server to read glue referral objects instead of following the referral. NVDS uses this control to manage glue or reference objects.

INCLUDE_SUBENTRIES_CONTROL_ID
The Subentries control on a ONE-LEVEL or SUBTREE search operation tells the server to show objects containing 'ldapSubEntry' in its objectClass list in addition to normal entries. If the control is not present, ldapSubEntry objects are omitted from the results. However, when the search scope is 'baseObject', the object is returned whether or not the control is present.

RESOLVE_ALIAS_CONTROL_ID
This control causes all aliases to be dereferenced while resolving the name. This effectively causes all operations to be applied to the target of the alias instead of the alias object itself.

Parameters:

controlOID - An identifier specifying which control to use. For example: LDAPNamespace.MANAGE_DSA_IT_CONTROL

Returns:

true if the control was already set.

Throws:

javax.naming.NamingException - if an error occurred setting the control or if the controlOID is unknown.

clearControl

boolean clearControl(java.lang.String controlOID)
              throws javax.naming.NamingException

Clears the specified control on this context. Subsequent LDAP operations will no longer have this control added.

Parameters:

controlOID - An identifier specifying which control to set.

Returns:

true if the control was previously set.

Throws:

javax.naming.NamingException - if an error occurred clearing the control

isControlSet

boolean isControlSet(java.lang.String controlOID)
              throws javax.naming.NamingException

Tests whether a control is currently set on this context.

Parameters:

controlOID - An identifier specifying which control test.

Returns:

true if the control is being sent with all LDAP operations.

Throws:

javax.naming.NamingException - if an error occurred clearing the control

getSupportedExtensions

java.util.ArrayList getSupportedExtensions()

Returns a list of OIDs representing the LDAP extensions supported by this server.

Returns:

an ArrayList of Strings containing OIDs of supported extensions.

getSupportedControls

java.util.ArrayList getSupportedControls()

Returns a list of OIDs representing the LDAP controls supported by this server.

Returns:

an ArrayList of Strings containing OIDs of supported controls.

getNamingContexts

java.lang.String[] getNamingContexts()

Get the naming contexts on the current server. The naming context should be used as a base DN of the subtree to be managed. For example, the naming context might be "ou=sales,dc=novell,dc=com". One should start with this object instead of the root of the LDAP tree.

Returns:

A String array containing the naming contexts.

sendXMLRequest

java.lang.String sendXMLRequest(java.lang.String servicePath,
                                java.lang.String xmlRequest)
                         throws javax.naming.NamingException

Sends an NVDS XML Payload Extension to the server

Parameters:

servicePath - a String containing the desired service.
This string is in the form: service/category/subagent/scheme/operation

xmlRequest - the XML request document

Returns:

a String containing the response in XML. May be null.

Throws:

javax.naming.NamingException

getNVDSEffectivePrivileges

ValueList[] getNVDSEffectivePrivileges(ObjectEntry obj,
                                       boolean allLegalAttrs)
                                throws SPIException

NVDS-specific method to get effective rights of the logged-in user on an object. This API takes a boolean argument indicating whether to return rights for all legal attributes, or only the ones with values.

Parameters:

obj - The object.

allLegalAttrs - If true, return rights for all legal attributes specified by the attribute definition, plus entry rights. If false, return entry rights only.

Returns:

A ValueList array containing the effective rights in ACL format.

Throws:

SPIException

getNVDSEffectivePrivileges

ValueList[] getNVDSEffectivePrivileges(ObjectEntry obj,
                                       java.lang.String[] attrs,
                                       java.lang.String[] classes)
                                throws SPIException

NVDS-specific method to get effective rights of the logged-in user on an object. This API takes two String arrays containing the desired attributes and classes.

Parameters:

obj - The object.

attrs - a String array containing the desired attributes for which rights are to be returned. May be null.

classes - a String array containing the desired classes for which rights are to be returned. May be null.

Returns:

A ValueList array containing the effective rights in ACL format.

Throws:

SPIException

getProviderURL

java.lang.String getProviderURL()
                         throws javax.naming.NamingException

Returns the LDAP server's host name and port number to which this namespace is authenticated.

Returns:

a String containing a URL. For example: "ldap://100.101.102.103:389"

Throws:

javax.naming.NamingException