com.openmarket.directory.cs

Class PluginDir

java.lang.Object

com.openmarket.directory.cs.CSDir

com.openmarket.directory.cs.PluginDir

All Implemented Interfaces:

IDir, IUserDir

Direct Known Subclasses:

LDAPDir, NTDir

public class PluginDir
extends CSDir
implements IDir, IUserDir

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

Field Summary

Fields inherited from class com.openmarket.directory.cs.CSDir

aclColumn, CLASS_, CLOSE_PAREN, comma, correlation, dot, idColumn, nameColumn, OPEN_PAREN, passwordColumn, queryAll, urlValueColumn, usernameColumn, valueColumn, whereAll

Constructor Summary

Constructors

Constructor and Description
PluginDir(ICS ics)
PluginDir(ICS ics, boolean bEditAttributes)
PluginDir(ICS ics, IDir idir)
PluginDir(ICS ics, IDir dir, boolean bEditAttributes)

Method Summary

Modifier and Type	Method and Description
void	addAttrs(ICS ics, IName dn, Attributes attributes) Add attributes to an existing entry.
void	addGroupMember(ICS ics, IName group, IName member) Add a user to a group.
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)
void	create(ICS ics, IName entry, 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[] attrIds) Retrieve the specified attributes from the specified entry.
Collection	groupMembers(ICS ics, IName group) List all direct members (users and groups) of the specified group
Collection	groupMemberships(ICS ics, IName dn) List all groups to which the specified entry directly belongs.
protected String	INameToPluginID(ICS ics, IName dn)
Collection	listUsers(ICS ics) Lists all users (descendants of Properties.peopleParent)
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	removeGroupMember(ICS ics, IName group, IName member) Remove a user from a group.
void	replaceAttrs(ICS ics, IName dn, Attributes attributes) Replace the existing attribute value(s) with the specified value(s).

Methods inherited from class com.openmarket.directory.cs.CSDir

addAttrs, children, deleteAttrs, doGroupSearch, doUserSearch, getGroupName, getID, getRequiredColumn, getSpecialAtts, getSystemUserAttrs, groupHierarchicalMembers, groupHierarchicalMemberships, listGroups, listGroups, listUsers, restoreVar, setVar, verifyIList

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openmarket.directory.IDir

children

Methods inherited from interface com.openmarket.directory.IUserDir

groupHierarchicalMembers, groupHierarchicalMemberships, listGroups, listGroups, listUsers

Constructor Detail

PluginDir

public PluginDir(ICS ics)

PluginDir

public PluginDir(ICS ics,
                 boolean bEditAttributes)

PluginDir

public PluginDir(ICS ics,
                 IDir idir)

PluginDir

public PluginDir(ICS ics,
                 IDir dir,
                 boolean bEditAttributes)

Method Detail

create

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

Description copied from interface: IDir

Create an object.

Specified by:

create in interface IDir

Overrides:

create in class CSDir

entry - 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

public void delete(ICS ics,
                   IName dn)
            throws DirectoryException

Description copied from interface: IDir

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

Specified by:

delete in interface IDir

Overrides:

delete in class CSDir

dn - Distinguished name of entry to be deleted.

Throws:

DirectoryException

andSearch

public Collection andSearch(ICS ics,
                            Attributes matchingAttributes)
                     throws DirectoryException

Description copied from interface: IDir

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

Specified by:

andSearch in interface IDir

Overrides:

andSearch in class CSDir

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

andSearch

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

Description copied from interface: IDir

Simple search returns all entries with matching attributes (AND)

Specified by:

andSearch in interface IDir

Overrides:

andSearch in class CSDir

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

public Collection orSearch(ICS ics,
                           Attributes matchingAttributes)
                    throws DirectoryException

Description copied from interface: IDir

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

Specified by:

orSearch in interface IDir

Overrides:

orSearch in class CSDir

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

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

Description copied from interface: IDir

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

Specified by:

orSearch in interface IDir

Overrides:

orSearch in class CSDir

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

addAttrs

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

Description copied from interface: IDir

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.

Specified by:

addAttrs in interface IDir

Overrides:

addAttrs in class CSDir

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

attributes - Attributes to be added.

Throws:

DirectoryException

replaceAttrs

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

Description copied from interface: IDir

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

Specified by:

replaceAttrs in interface IDir

Overrides:

replaceAttrs in class CSDir

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

attributes - Attributes to be replaced.

Throws:

DirectoryException

deleteAttrs

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

Description copied from interface: IDir

Delete the specified attributes from the specified entry.

Specified by:

deleteAttrs in interface IDir

Overrides:

deleteAttrs in class CSDir

attributes - Attributes to be removed.

Throws:

DirectoryException

addGroupMember

public void addGroupMember(ICS ics,
                           IName group,
                           IName member)
                    throws DirectoryException

Description copied from interface: IUserDir

Add a user to a group.

Specified by:

addGroupMember in interface IUserDir

Overrides:

addGroupMember in class CSDir

Parameters:

ics - The current ICS context

group - The distinguished name of the group.

member - The distinguished name of the user.

Throws:

DirectoryException - If there is an error.

removeGroupMember

public void removeGroupMember(ICS ics,
                              IName group,
                              IName member)
                       throws DirectoryException

Description copied from interface: IUserDir

Remove a user from a group.

Specified by:

removeGroupMember in interface IUserDir

Overrides:

removeGroupMember in class CSDir

Parameters:

ics - The current ICS context

group - The distinguished name of the group.

member - The distinguished name of the user.

Throws:

DirectoryException - If there is an error.

listUsers

public Collection listUsers(ICS ics)
                     throws DirectoryException

Description copied from interface: IUserDir

Lists all users (descendants of Properties.peopleParent)

Specified by:

listUsers in interface IUserDir

Overrides:

listUsers in class CSDir

Parameters:

ics - The current ICS context

Returns:

Collection of the distinguished names (Strings) of all the user descendants to Properties.peopleParent

Throws:

DirectoryException - If there is an error.

groupMembers

public Collection groupMembers(ICS ics,
                               IName group)
                        throws DirectoryException

Description copied from interface: IUserDir

List all direct members (users and groups) of the specified group

Specified by:

groupMembers in interface IUserDir

Overrides:

groupMembers in class CSDir

Parameters:

ics - The current ICS context

group - The distinguished name of the group. If the common name is used and is not unique, the Properties.groupParent property is used to distinguish the name.

Returns:

Collection of distinguished names (Strings) of the members of the group. Returns empty set if the group has no members, never null.

Throws:

DirectoryException - If there is an error.

getAttrs

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

Description copied from interface: IDir

Retrieve the specified attributes from the specified entry.

Specified by:

getAttrs in interface IDir

Overrides:

getAttrs in class CSDir

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

attrIds - 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

groupMemberships

public Collection groupMemberships(ICS ics,
                                   IName dn)
                            throws DirectoryException

Description copied from interface: IUserDir

List all groups to which the specified entry directly belongs.

Specified by:

groupMemberships in interface IUserDir

Overrides:

groupMemberships in class CSDir

Parameters:

ics - The current ICS context

dn - The distinguished name of the entry. If the common name is used and is not unique, the Properties.groupParent property is used to distinguish the name.

Returns:

Collection of the distinguished (Strings) names of the groups to which the specified entry is a direct member. Returns empty set if entry belongs to no group, never null.

Throws:

DirectoryException - If there is an error.

INameToPluginID

protected String INameToPluginID(ICS ics,
                                 IName dn)
                          throws DirectoryException

Throws:

DirectoryException