com.openmarket.directory.cs

Class CSDir

java.lang.Object

com.openmarket.directory.cs.CSDir

All Implemented Interfaces:

IDir, IUserDir

Direct Known Subclasses:

CustomDir, PluginDir

public class CSDir
extends java.lang.Object
implements IDir, IUserDir

Supports the dir tagsets. Refer to that documentation for the values set for errno. $Revision: 28 $

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	aclColumn
protected static java.lang.String	CLASS_
protected static char	CLOSE_PAREN
protected static char	comma
protected static char	correlation
protected static char	dot
protected static java.lang.String	idColumn
protected static java.lang.String	nameColumn
protected static char	OPEN_PAREN
protected static java.lang.String	passwordColumn
protected static java.lang.String	queryAll
protected static java.lang.String	urlValueColumn
protected static java.lang.String	usernameColumn
protected static java.lang.String	valueColumn
protected static char	whereAll

Constructor Summary

Constructors

Constructor and Description
CSDir(COM.FutureTense.Interfaces.ICS ics)
CSDir(COM.FutureTense.Interfaces.ICS ics, IDir idir)

Method Summary

Modifier and Type	Method and Description
void	addAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes) Add attributes to an existing entry.
void	addAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes, java.lang.Object oBatchContext)
void	addGroupMember(COM.FutureTense.Interfaces.ICS ics, IName group, IName member) Add a user to a group.
java.util.Collection	andSearch(COM.FutureTense.Interfaces.ICS ics, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND); searches under Properties.baseDN
java.util.Collection	andSearch(COM.FutureTense.Interfaces.ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND)
java.util.Collection	children(COM.FutureTense.Interfaces.ICS ics, IName dn) Retrieves the immediate child entries of the specified parent.
void	create(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes) Create an object.
void	delete(COM.FutureTense.Interfaces.ICS ics, IName dn) Delete the specified entry.
void	deleteAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes) Delete the specified attributes from the specified entry.
void	deleteAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes, java.lang.Object oBatchContext)
protected java.util.Collection	doGroupSearch(COM.FutureTense.Interfaces.ICS ics, Attributes matchingAttributes, boolean bAnd)
protected java.util.Collection	doUserSearch(COM.FutureTense.Interfaces.ICS ics, Attributes matchingAttributes, boolean bAnd)
Attributes	getAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, java.lang.String[] attrIds) Retrieve the specified attributes from the specified entry.
protected java.lang.String	getGroupName(COM.FutureTense.Interfaces.ICS ics, IName dn)
protected java.lang.String	getID(COM.FutureTense.Interfaces.ICS ics, IName dn)
protected java.lang.String	getRequiredColumn(COM.FutureTense.Interfaces.ICS ics, COM.FutureTense.Interfaces.IList list, java.lang.String colName, java.lang.String METHOD)
protected void	getSpecialAtts(Attributes atts, COM.FutureTense.Interfaces.ICS ics, java.lang.String id, java.lang.String[] attrIds)
protected Attributes	getSystemUserAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, java.lang.String[] attrIds)
java.util.Collection	groupHierarchicalMembers(COM.FutureTense.Interfaces.ICS ics, IName dn) List all user members, direct and inherited, of the specified group.
java.util.Collection	groupHierarchicalMemberships(COM.FutureTense.Interfaces.ICS ics, IName dn) List all groups to which the specified entry belongs, directly or inherited.
java.util.Collection	groupMembers(COM.FutureTense.Interfaces.ICS ics, IName group) List all direct members (users and groups) of the specified group
java.util.Collection	groupMemberships(COM.FutureTense.Interfaces.ICS ics, IName dn) List all groups to which the specified entry directly belongs.
java.util.Collection	listGroups(COM.FutureTense.Interfaces.ICS ics) Lists all groups (descendants of Properties.groupParent)
java.util.Collection	listGroups(COM.FutureTense.Interfaces.ICS ics, IName commonAncestor) Lists all groups descended from a specified node.
java.util.Collection	listUsers(COM.FutureTense.Interfaces.ICS ics) Lists all users (descendants of Properties.peopleParent)
java.util.Collection	listUsers(COM.FutureTense.Interfaces.ICS ics, IName commonAncestor) Lists all users descended from a specified node.
java.util.Collection	orSearch(COM.FutureTense.Interfaces.ICS ics, Attributes matchingAttributes) Simple search returns all entries with attributes matching any of those specified (OR); searches under Properties.baseDN
java.util.Collection	orSearch(COM.FutureTense.Interfaces.ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries attributes matching any of those specified (OR)
void	removeGroupMember(COM.FutureTense.Interfaces.ICS ics, IName group, IName member) Remove a user from a group.
void	replaceAttrs(COM.FutureTense.Interfaces.ICS ics, IName dn, Attributes attributes) Replace the existing attribute value(s) with the specified value(s).
protected void	restoreVar(COM.FutureTense.Interfaces.ICS ics, java.lang.String varName, java.lang.String oldValue)
protected java.lang.String	setVar(COM.FutureTense.Interfaces.ICS ics, java.lang.String varName, java.lang.String newValue)
protected boolean	verifyIList(COM.FutureTense.Interfaces.ICS ics, COM.FutureTense.Interfaces.IList list, java.lang.String METHOD)

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_

protected static final java.lang.String CLASS_

See Also:

Constant Field Values

usernameColumn

protected static final java.lang.String usernameColumn

See Also:

Constant Field Values

passwordColumn

protected static final java.lang.String passwordColumn

See Also:

Constant Field Values

aclColumn

protected static final java.lang.String aclColumn

See Also:

Constant Field Values

idColumn

protected static final java.lang.String idColumn

See Also:

Constant Field Values

nameColumn

protected static final java.lang.String nameColumn

See Also:

Constant Field Values

valueColumn

protected static final java.lang.String valueColumn

See Also:

Constant Field Values

urlValueColumn

protected static final java.lang.String urlValueColumn

See Also:

Constant Field Values

queryAll

protected static final java.lang.String queryAll

See Also:

Constant Field Values

comma

protected static final char comma

See Also:

Constant Field Values

whereAll

protected static final char whereAll

See Also:

Constant Field Values

correlation

protected static final char correlation

See Also:

Constant Field Values

dot

protected static final char dot

See Also:

Constant Field Values

OPEN_PAREN

protected static final char OPEN_PAREN

See Also:

Constant Field Values

CLOSE_PAREN

protected static final char CLOSE_PAREN

See Also:

Constant Field Values

Constructor Detail

CSDir

public CSDir(COM.FutureTense.Interfaces.ICS ics)

CSDir

public CSDir(COM.FutureTense.Interfaces.ICS ics,
             IDir idir)

Method Detail

create

public void create(COM.FutureTense.Interfaces.ICS ics,
                   IName dn,
                   Attributes attributes)
            throws DirectoryException

Description copied from interface: IDir

Create an object.

Specified by:

create in interface IDir

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

public void delete(COM.FutureTense.Interfaces.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

dn - Distinguished name of entry to be deleted.

Throws:

DirectoryException

andSearch

public java.util.Collection andSearch(COM.FutureTense.Interfaces.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

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

andSearch

public java.util.Collection andSearch(COM.FutureTense.Interfaces.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

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

public java.util.Collection orSearch(COM.FutureTense.Interfaces.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

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

orSearch

public java.util.Collection orSearch(COM.FutureTense.Interfaces.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

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

doGroupSearch

protected java.util.Collection doGroupSearch(COM.FutureTense.Interfaces.ICS ics,
                                             Attributes matchingAttributes,
                                             boolean bAnd)
                                      throws DirectoryException

Throws:

DirectoryException

doUserSearch

protected java.util.Collection doUserSearch(COM.FutureTense.Interfaces.ICS ics,
                                            Attributes matchingAttributes,
                                            boolean bAnd)
                                     throws DirectoryException

Throws:

DirectoryException

listUsers

public java.util.Collection listUsers(COM.FutureTense.Interfaces.ICS ics)
                               throws DirectoryException

Description copied from interface: IUserDir

Lists all users (descendants of Properties.peopleParent)

Specified by:

listUsers in interface IUserDir

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.

listUsers

public java.util.Collection listUsers(COM.FutureTense.Interfaces.ICS ics,
                                      IName commonAncestor)
                               throws DirectoryException

Description copied from interface: IUserDir

Lists all users descended from a specified node.

Specified by:

listUsers in interface IUserDir

Parameters:

ics - The current ICS context

commonAncestor - The node from which to list descendant users

Returns:

Collection of the distinguished names (Strings) of all the user descendants to commonAncestor

Throws:

DirectoryException - If there is an error.

listGroups

public java.util.Collection listGroups(COM.FutureTense.Interfaces.ICS ics)
                                throws DirectoryException

Description copied from interface: IUserDir

Lists all groups (descendants of Properties.groupParent)

Specified by:

listGroups in interface IUserDir

Parameters:

ics - The current ICS context

Returns:

Collection of the distinguished names (Strings) of all the group descendants to Properties.groupParent

Throws:

DirectoryException - If there is an error.

listGroups

public java.util.Collection listGroups(COM.FutureTense.Interfaces.ICS ics,
                                       IName commonAncestor)
                                throws DirectoryException

Description copied from interface: IUserDir

Lists all groups descended from a specified node.

Specified by:

listGroups in interface IUserDir

Parameters:

ics - The current ICS context

commonAncestor - The node from which to list descendant groups

Returns:

Collection of the distinguished names (Strings) of all the group descendants to commonAncestor

Throws:

DirectoryException - If there is an error.

children

public java.util.Collection children(COM.FutureTense.Interfaces.ICS ics,
                                     IName dn)
                              throws DirectoryException

Description copied from interface: IDir

Retrieves the immediate child entries of the specified parent.

Specified by:

children in interface IDir

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

Throws:

DirectoryException

addAttrs

public void addAttrs(COM.FutureTense.Interfaces.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

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

attributes - Attributes to be added.

Throws:

DirectoryException

addAttrs

public void addAttrs(COM.FutureTense.Interfaces.ICS ics,
                     IName dn,
                     Attributes attributes,
                     java.lang.Object oBatchContext)
              throws DirectoryException

Throws:

DirectoryException

replaceAttrs

public void replaceAttrs(COM.FutureTense.Interfaces.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

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

attributes - Attributes to be replaced.

Throws:

DirectoryException

deleteAttrs

public void deleteAttrs(COM.FutureTense.Interfaces.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

attributes - Attributes to be removed.

Throws:

DirectoryException

deleteAttrs

public void deleteAttrs(COM.FutureTense.Interfaces.ICS ics,
                        IName dn,
                        Attributes attributes,
                        java.lang.Object oBatchContext)
                 throws DirectoryException

Throws:

DirectoryException

getAttrs

public Attributes getAttrs(COM.FutureTense.Interfaces.ICS ics,
                           IName dn,
                           java.lang.String[] attrIds)
                    throws DirectoryException

Description copied from interface: IDir

Retrieve the specified attributes from the specified entry.

Specified by:

getAttrs in interface IDir

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

getSystemUserAttrs

protected Attributes getSystemUserAttrs(COM.FutureTense.Interfaces.ICS ics,
                                        IName dn,
                                        java.lang.String[] attrIds)
                                 throws DirectoryException

Throws:

DirectoryException

getSpecialAtts

protected void getSpecialAtts(Attributes atts,
                              COM.FutureTense.Interfaces.ICS ics,
                              java.lang.String id,
                              java.lang.String[] attrIds)
                       throws DirectoryException

Throws:

DirectoryException

addGroupMember

public void addGroupMember(COM.FutureTense.Interfaces.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

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(COM.FutureTense.Interfaces.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

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.

groupMembers

public java.util.Collection groupMembers(COM.FutureTense.Interfaces.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

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.

groupHierarchicalMembers

public java.util.Collection groupHierarchicalMembers(COM.FutureTense.Interfaces.ICS ics,
                                                     IName dn)
                                              throws DirectoryException

Description copied from interface: IUserDir

List all user members, direct and inherited, of the specified group.

Specified by:

groupHierarchicalMembers in interface IUserDir

Parameters:

ics - The current ICS context

dn - 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 user members, direct and inherited, of the group. Returns empty set if the group has no members, never null.

Throws:

DirectoryException - If there is an error.

groupMemberships

public java.util.Collection groupMemberships(COM.FutureTense.Interfaces.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

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.

groupHierarchicalMemberships

public java.util.Collection groupHierarchicalMemberships(COM.FutureTense.Interfaces.ICS ics,
                                                         IName dn)
                                                  throws DirectoryException

Description copied from interface: IUserDir

List all groups to which the specified entry belongs, directly or inherited.

Specified by:

groupHierarchicalMemberships in interface IUserDir

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 member, directly or inherited. Returns empty set if entry belongs to no group, never null.

Throws:

DirectoryException - If there is an error.

getID

protected java.lang.String getID(COM.FutureTense.Interfaces.ICS ics,
                                 IName dn)
                          throws DirectoryException

Throws:

DirectoryException

getGroupName

protected java.lang.String getGroupName(COM.FutureTense.Interfaces.ICS ics,
                                        IName dn)
                                 throws DirectoryException

Throws:

DirectoryException

setVar

protected java.lang.String setVar(COM.FutureTense.Interfaces.ICS ics,
                                  java.lang.String varName,
                                  java.lang.String newValue)

restoreVar

protected void restoreVar(COM.FutureTense.Interfaces.ICS ics,
                          java.lang.String varName,
                          java.lang.String oldValue)

verifyIList

protected boolean verifyIList(COM.FutureTense.Interfaces.ICS ics,
                              COM.FutureTense.Interfaces.IList list,
                              java.lang.String METHOD)
                       throws DirectoryException

Throws:

DirectoryException

getRequiredColumn

protected java.lang.String getRequiredColumn(COM.FutureTense.Interfaces.ICS ics,
                                             COM.FutureTense.Interfaces.IList list,
                                             java.lang.String colName,
                                             java.lang.String METHOD)
                                      throws DirectoryException

Throws:

DirectoryException