Class ADsNamespaces

public class ADsNamespaces implements IADsNamespaces
{
  // Constructors
  public ADsNamespaces(ADsConn conn);

  // Methods
  public IADs CopyHere(String SourceObject, String NewName)
        throws IADsException;
  public IADs Create(String Class, String RelativeName)
        throws IADsException;
  public IADs CreateProvider(String ProviderID,
        String ProviderPath) throws IADsException;
  public void Delete(String Class, String RelativeName)
        throws IADsException;
  public Object Get(String Name) throws IADsException;
  public Enumeration get__NewEnum();
  public String get_ADsPath();
  public String get_Class();
  public Long get_Count();
  public String get_DefaultContainer();
  public String[] get_Filter() throws IADsException;
  public String get_GUID() throws IADsException;
  public String[] get_Hints() throws IADsException;
  public String get_Name();
  public String get_Parent() throws IADsException;
  public String get_Schema() throws IADsException;
  public Vector GetEx(String Name) throws IADsException;
  public void GetInfo() throws IADsException;
  public void GetInfo(String Hints[]) throws IADsException;
  public IADs GetObject(String ProviderID,
        String ProviderPath) throws IADsException;
  public ADsProvider getProvider(String ProviderID);
  public IADs MoveHere(String SourceObject, String NewName)
        throws IADsException;
  public void Put(String Name, Object Prop) throws IADsException;
  public void put_DefaultContainer(String DefaultContainer);
  public void put_Filter(String Filter[]) throws IADsException;
  public void put_Hints(String Hints[]) throws IADsException;
  public void PutEx(int ControlCode, String Name,
        Vector Prop) throws IADsException;
  public void SetInfo() throws IADsException;
}

This class implements IADsNamespaces object. The namespaces object contains a list of provider-specific namespace objects.

Also see Also Active Directory Design Specification Version 1.0

Constructors

ADsNamespaces

public ADsNamespaces(ADsConn conn);

Constructs a ADsNamespaces object that contains all provider specific namespace object.

Methods

CopyHere 

public IADs CopyHere(String SourceObject, String NewName)
        throws IADsException;

Creates a new object in this container identical to the specified object and returns a pointer to the new object. The destination container must be in the same namespace as the source. Copying objects across namespaces is not permitted. NewName is an optional parameter that, if present, contains the name inside the container. Note that this method is not implemented by ADsNamespaces.

Return Value

Returns copied object

Parameter	Description
SourceObject	source object
NewName	new name

Exceptions

IADsException failed to copy

Create 

public IADs Create(String Class, String RelativeName)
        throws IADsException;

Creates an object of the class specified by Class, of name RelativeName, and returns the newly created object. The object is not actually created within the directory service until IADs::SetInfo method is executed on the newly created object.

Return Value

Returns newly created IADs object

Parameter	Description
Class	class name
RelativeName	relative name

Exceptions

IADsException failed to get create

CreateProvider 

public IADs CreateProvider(String ProviderID,
        String ProviderPath) throws IADsException;

Creates a provider specified by the provider id, and provider path.

Return Value

Returns newly created provider object

Parameter	Description
ProviderID	provider identifier
ProviderPath	provider path

Exceptions

IADsException failed to create

Delete 

public void Delete(String Class, String RelativeName)
        throws IADsException;

Deletes the object identified by the provided class and relative name. Note that this method is not implemented by ADsNamespaces.

Parameter	Description
Class	class name
RelativeName	relative name

Exceptions

IADsException failed to delete

Get 

public Object Get(String Name) throws IADsException;

Retrieves the value for a named property. Note that this method is not implemented for ADsNamespaces.

Return Value

Returns property value

Parameter	Description
Name	property intereted

Exceptions

IADsException failed to get

get__NewEnum 

public Enumeration get__NewEnum();

Gets an enumerator Namespace object

Return Value

Returns enumeration of Namespace object

get_ADsPath 

public String get_ADsPath();

Gets the ADsPath string of the object that uniquely identifies the object in a heterogeneous environment.

Return Value

Returns ADsPath string of this object

get_Class 

public String get_Class();

Gets the name of the schema class of this object.

Return Value

Returns schema class

get_Count 

public Long get_Count();

Gets the number of Active Directory objects within the ADsNamespaces.

Return Value

Returns number of objects within the ADsNamespaces

get_DefaultContainer 

public String get_DefaultContainer();

Gets the default container value. If no value has been set, the Namespaces object return the container that it determines is the most relevant.

Return Value

Returns default container

get_Filter 

public String[] get_Filter() throws IADsException;

Gets the filter on the object classes that will be returned in a given enumeration. Note that this method is not implemented by ADsNamespaces.

Return Value

Returns filter

Exceptions

IADsException Thrown when failed to retrieve filter.

get_GUID 

public String get_GUID() throws IADsException;

Gets the unique identifier for objects of this schema class. Each Active Directory object type is uniquely identified by a GUID. This GUID is the Active Directory abstraction of the globally unique identifier for the schema class, analogous to an ASN.1 OID.

Return Value

Returns unique identifier

Exceptions

IADsException Thrown when not implemented.

get_Hints 

public String[] get_Hints() throws IADsException;

Gets the hint parameters that allows the client to indicate which properties should be loaded, so the provider can attempt to optmize network access. Note that this method is not implemented by ADsNamespaces.

Return Value

Returns hints

Exceptions

IADsException Thrown when failed to retrieve hints.

get_Name 

public String get_Name();

Gets the relative name of the object as named within the underlying namespace.

Return Value

Returns name

get_Parent 

public String get_Parent() throws IADsException;

Gets the ADsPath string of the parent container.

Return Value

Returns ADsPath string of the parent of this object

Exceptions

IADsException Thrown when not implemented.

get_Schema 

public String get_Schema() throws IADsException;

Gets the ADsPath of the schema class of this object.

Return Value

Returns schema class name

Exceptions

IADsException Thrown when not implemented.

GetEx 

public Vector GetEx(String Name) throws IADsException;

Retrieves the values for a named single or multi-valued property. Note that this method is not implemented for ADsNamespaces.

Return Value

Returns property value

Parameter	Description
Name	property intereted

Exceptions

IADsException failed to get

GetInfo 

public void GetInfo() throws IADsException;

Reloads the object with the property values that exist within the directory service. Note that this method is not implemented for ADsNamespaces.

Parameter	Description
Hints	properties (list of Strings) should be loaded, so that provider can attempt to optimize network access.

Exceptions

IADsException failed to refresh

GetInfo 

public void GetInfo(String Hints[]) throws IADsException;

GetObject 

public IADs GetObject(String ProviderID,
        String ProviderPath) throws IADsException;

Returns the IADs interface of the item in the container identified by the object's class and relative name (this is the value of the object's IADs::Name property). If the class name is not provided the provider will return the first item found with the specified name in the current container.

Return Value

Returns IADs object

Parameter	Description
ProviderID	provider identifier
ProviderPath	provider path

Exceptions

IADsException failed to get object

getProvider 

public ADsProvider getProvider(String ProviderID);

Retrives the provider implementation.

Parameter	Description
Provider	provider id

MoveHere 

public IADs MoveHere(String SourceObject, String NewName)
        throws IADsException;

Moves the specified object to this container and returns a pointr to the newobject. The destination container must be in the same namespace as the source. Moving obejcts across namespaces i not permitted. NewName is an optional parameter that, if present, contans the name insdie the container. Note that this method is not implemented by ADsNamespaces.

Return Value

Returns moved object

Parameter	Description
SourceObject	source object
NewName	new name

Exceptions

IADsException failed to move

Put 

public void Put(String Name, Object Prop) throws IADsException;

Sets the value for a named property. Note that this method is not implemented for ADsNamespaces.

Parameter	Description
Name	property interested
Prop	property value

Exceptions

IADsException failed to put

put_DefaultContainer 

public void put_DefaultContainer(String DefaultContainer);

Sets the default container value. If no value has been set, the Namespaces object return the container that it determines is the most relevant.

Parameter	Description
DefaultContainer	default container

put_Filter 

public void put_Filter(String Filter[]) throws IADsException;

Sets the filter on the object classes that will be returned in a given enumeration. Note that this method is not implemented by ADsNamespaces.

Parameter	Description
Filter	filter

Exceptions

IADsException Thrown when failed to put filter.

put_Hints 

public void put_Hints(String Hints[]) throws IADsException;

Sets the hint parameters that allows the client to indicate which properties should be loaded, so the provider can attempt to optimize network access. Note that this method is not implemented by ADsNamespaces.

Parameter	Description
Hints	hints

Exceptions

IADsException Thrown when failed to put hints.

PutEx 

public void PutEx(int ControlCode, String Name,
        Vector Prop) throws IADsException;

Sets the values for a named single or multi-valued property. Note that this method is not implemented for ADsNamespaces.

Parameter	Description
ControlCode	Indicates either clear or update operation being performed
Name	property interested
Prop	property value

Exceptions

IADsException failed to put

SetInfo 

public void SetInfo() throws IADsException;

Commits changes on the object. If properties have been changed on an object, the SetInfo method will cauase the properties to be changed within the directory service. Note that this method is not implemented for ADsNamespaces.

Exceptions

IADsException failed to commit