com.openmarket.directory

Interface IDir

All Known Implementing Classes:

AMServerDir, BaseDir, CSDir, CustomDir, JNDIAuthDir, JNDIDir, LDAPDir, NTDir, PluginDir

public interface IDir

Supports the dir tagsets. Refer to that documentation for the values set for errno.

Method Summary

Modifier and Type	Method and Description
void	addAttrs(ICS ics, IName dn, Attributes attributes) Add attributes to an existing entry.
Collection	andSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND); searches under Properties.baseDN
Collection	andSearch(ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND)
Collection	children(ICS ics, IName dn) Retrieves the immediate child entries of the specified parent.
void	create(ICS ics, IName dn, Attributes attributes) Create an object.
void	delete(ICS ics, IName dn) Delete the specified entry.
void	deleteAttrs(ICS ics, IName dn, Attributes attributes) Delete the specified attributes from the specified entry.
Attributes	getAttrs(ICS ics, IName dn, String[] attrs) Retrieve the specified attributes from the specified entry.
Collection	orSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with attributes matching any of those specified (OR); searches under Properties.baseDN
Collection	orSearch(ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries attributes matching any of those specified (OR)
void	replaceAttrs(ICS ics, IName dn, Attributes attributes) Replace the existing attribute value(s) with the specified value(s).

Method Detail

create

void create(ICS ics,
            IName dn,
            Attributes attributes)
     throws DirectoryException

Create an object.

Parameters:

dn - Distinguished name of entry to be created.

attributes - Attribute(s) to create for this entry. If null, creates entry with no attributes.

Throws:

DirectoryException

delete

void delete(ICS ics,
            IName dn)
     throws DirectoryException

Delete the specified entry. Maintain referential integrity, if configured to do so.

Parameters:

dn - Distinguished name of entry to be deleted.

Throws:

DirectoryException

andSearch

Collection andSearch(ICS ics,
                     Attributes matchingAttributes)
              throws DirectoryException

Simple search returns all entries with matching attributes (AND); searches under Properties.baseDN

Parameters:

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

andSearch

Collection andSearch(ICS ics,
                     IName parent,
                     Attributes matchingAttributes)
              throws DirectoryException

Simple search returns all entries with matching attributes (AND)

Parameters:

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

Collection orSearch(ICS ics,
                    Attributes matchingAttributes)
             throws DirectoryException

Simple search returns all entries with attributes matching any of those specified (OR); searches under Properties.baseDN

Parameters:

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

Collection orSearch(ICS ics,
                    IName parent,
                    Attributes matchingAttributes)
             throws DirectoryException

Simple search returns all entries attributes matching any of those specified (OR)

Parameters:

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

children

Collection children(ICS ics,
                    IName dn)
             throws DirectoryException

Retrieves the immediate child entries of the specified parent.

Parameters:

dn - The distinguished name of the entry for which children are to be found.

Throws:

DirectoryException

addAttrs

void addAttrs(ICS ics,
              IName dn,
              Attributes attributes)
       throws DirectoryException

Add attributes to an existing entry. A single attribute name may have multiple values. The values are also order-dependant. Each attribute must have at least one value or DirectoryException will be thrown.

Parameters:

dn - The distinguished name of the entry to which attributes are added.

attributes - Attributes to be added.

Throws:

DirectoryException

replaceAttrs

void replaceAttrs(ICS ics,
                  IName dn,
                  Attributes attributes)
           throws DirectoryException

Replace the existing attribute value(s) with the specified value(s). Each attribute must have at least one value or DirectoryException will be thrown.

Parameters:

dn - The distinguished name of the entry for which attributes are being replaced.

attributes - Attributes to be replaced.

Throws:

DirectoryException

deleteAttrs

void deleteAttrs(ICS ics,
                 IName dn,
                 Attributes attributes)
          throws DirectoryException

Delete the specified attributes from the specified entry.

Parameters:

entry - The distinguished name of the entry for which attributes are being deleted.

attributes - Attributes to be removed.

Throws:

DirectoryException

getAttrs

Attributes getAttrs(ICS ics,
                    IName dn,
                    String[] attrs)
             throws DirectoryException

Retrieve the specified attributes from the specified entry.

Parameters:

dn - The distinguished name of the entry for which attributes are being retrieved.

attrs - The identifiers of the attributes to retrieve. null indicates that all attributes should be retrieved; an empty array indicates that none should be retrieved.

Throws:

DirectoryException