com.openmarket.directory.jndi

Class LDAPUserDir

java.lang.Object

com.openmarket.directory.jndi.LDAPUserDir

All Implemented Interfaces:

IUserDir

public class LDAPUserDir
extends Object
implements IUserDir

Base implementation of IUserDir assuming "standard" LDAP schema

Field Summary

Fields

Modifier and Type	Field and Description
protected IDir	m_iDir
static String	s_strGroupMember
static String	s_strGroupMembership
static String	s_strObjectClass
static String	s_strObjectClassGroup
static String	s_strObjectClassPerson
static String	s_strRootGroup
static String	s_strRootPerson
static String	searchhierarchical

Constructor Summary

Constructors

Constructor and Description
LDAPUserDir(ICS ics, IDir idir)

Method Summary

Modifier and Type	Method and Description
void	addGroupMember(ICS ics, IName group, IName member) Add a user to a group.
protected Attribute	getAttribute(ICS ics, IName dn, String attname) returns null if uniquemember attribute is not found.
protected int	getMemberIndex(ICS ics, Attribute memberAtt, IName member)
Collection	groupHierarchicalMembers(ICS ics, IName dn) List all user members, direct and inherited, of the specified group.
Collection	groupHierarchicalMemberships(ICS ics, IName dn) List all groups to which the specified entry belongs, directly or inherited.
Collection	groupMembers(ICS ics, IName dn) 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 HashMap	hierarchicalMembers(ICS ics, IName group, HashMap members, HashMap alreadyLooked)
protected HashMap	hierarchicalMemberships(ICS ics, HashMap groups, IName member)
protected boolean	isMember(ICS ics, IName group, IName member)
Collection	listGroups(ICS ics) Lists all groups (descendants of Properties.groupParent)
Collection	listGroups(ICS ics, IName commonAncestor) Lists all groups descended from a specified node.
Collection	listUsers(ICS ics) Lists all users (descendants of Properties.peopleParent)
Collection	listUsers(ICS ics, IName commonAncestor) Lists all users descended from a specified node.
void	removeGroupMember(ICS ics, IName group, IName member) Remove a user from a group.

Methods inherited from class java.lang.Object

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

Field Detail

m_iDir

protected IDir m_iDir

s_strObjectClass

public static String s_strObjectClass

s_strObjectClassPerson

public static String s_strObjectClassPerson

s_strObjectClassGroup

public static String s_strObjectClassGroup

s_strRootPerson

public static String s_strRootPerson

s_strRootGroup

public static String s_strRootGroup

s_strGroupMember

public static String s_strGroupMember

s_strGroupMembership

public static String s_strGroupMembership

searchhierarchical

public static String searchhierarchical

Constructor Detail

LDAPUserDir

public LDAPUserDir(ICS ics,
                   IDir idir)

Method Detail

listUsers

public Collection listUsers(ICS ics)
                     throws DirectoryException

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 Collection listUsers(ICS ics,
                            IName commonAncestor)
                     throws DirectoryException

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 Collection listGroups(ICS ics)
                      throws DirectoryException

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 Collection listGroups(ICS ics,
                             IName commonAncestor)
                      throws DirectoryException

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.

groupMembers

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

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

Specified by:

groupMembers 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 members of the group. Returns empty set if the group has no members, never null.

Throws:

DirectoryException - If there is an error.

groupHierarchicalMembers

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

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 Collection groupMemberships(ICS ics,
                                   IName dn)
                            throws DirectoryException

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 Collection groupHierarchicalMemberships(ICS ics,
                                               IName dn)
                                        throws DirectoryException

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.

addGroupMember

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

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(ICS ics,
                              IName group,
                              IName member)
                       throws DirectoryException

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.

hierarchicalMembers

protected HashMap hierarchicalMembers(ICS ics,
                                      IName group,
                                      HashMap members,
                                      HashMap alreadyLooked)
                               throws DirectoryException

Throws:

DirectoryException

hierarchicalMemberships

protected HashMap hierarchicalMemberships(ICS ics,
                                          HashMap groups,
                                          IName member)
                                   throws DirectoryException

Throws:

DirectoryException

isMember

protected boolean isMember(ICS ics,
                           IName group,
                           IName member)
                    throws DirectoryException

Throws:

DirectoryException

getMemberIndex

protected int getMemberIndex(ICS ics,
                             Attribute memberAtt,
                             IName member)
                      throws DirectoryException

Throws:

DirectoryException

getAttribute

protected Attribute getAttribute(ICS ics,
                                 IName dn,
                                 String attname)
                          throws DirectoryException

returns null if uniquemember attribute is not found.

Throws:

DirectoryException