com.openmarket.directory

Interface IUserDir

All Known Implementing Classes:

AMServerDir, CSDir, CustomDir, LDAPDir, LDAPUserDir, NTDir, PluginDir

public interface IUserDir

Wrapper interface around IDir exposing user and group semantics

Method Summary

Modifier and Type	Method and Description
void	addGroupMember(ICS ics, IName group, IName member) Add a user to a group.
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.
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.

Method Detail

listUsers

Collection listUsers(ICS ics)
              throws DirectoryException

Lists all users (descendants of Properties.peopleParent)

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

Collection listUsers(ICS ics,
                     IName commonAncestor)
              throws DirectoryException

Lists all users descended from a specified node.

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

Collection listGroups(ICS ics)
               throws DirectoryException

Lists all groups (descendants of Properties.groupParent)

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

Collection listGroups(ICS ics,
                      IName commonAncestor)
               throws DirectoryException

Lists all groups descended from a specified node.

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

Collection groupMembers(ICS ics,
                        IName dn)
                 throws DirectoryException

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

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

Collection groupHierarchicalMembers(ICS ics,
                                    IName dn)
                             throws DirectoryException

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

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

Collection groupMemberships(ICS ics,
                            IName dn)
                     throws DirectoryException

List all groups to which the specified entry directly belongs.

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

Collection groupHierarchicalMemberships(ICS ics,
                                        IName dn)
                                 throws DirectoryException

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

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

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

Add a user to a group.

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

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

Remove a user from a group.

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.