oracle.fatwire.sites.directory.custom

Class CustomDir

java.lang.Object

com.openmarket.directory.cs.CSDir

oracle.fatwire.sites.directory.custom.CustomDir

All Implemented Interfaces:

IDir, IUserDir

public class CustomDir
extends CSDir

This class provides read-only access to the user directory as the assumption is that all user maintenance operations are done in a central directory system. NOTE: To support all the operations of 'dir' tag library, you need to implement the methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	errorMessage
static org.apache.commons.logging.Log	log

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
CustomDir(ICS ics)
CustomDir(ICS ics, IDir idir)

Method Summary

Modifier and Type	Method and Description
void	addAttrs(ICS ics, IName dn, Attributes attributes) Add attributes to an existing entry.
void	addAttrs(ICS ics, IName dn, Attributes attributes, Object oBatchContext)
void	addGroupMember(ICS ics, IName group, IName member) Add a user to a group.
Collection<String>	andSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND); searches under Properties.baseDN
Collection<String>	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.
void	deleteAttrs(ICS ics, IName dn, Attributes attributes, Object oBatchContext)
Attributes	getAttrs(ICS ics, IName dn, String[] attrIds) Retrieve the specified attributes from the specified entry.
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<String>	groupMembers(ICS ics, IName group) List all direct members (users and groups) of the specified group
Collection<String>	groupMemberships_(ICS ics, IName dn)
Collection<String>	groupMemberships(ICS ics, IName dn) List all groups to which the specified entry directly belongs.
protected String	INameToCustomID(ICS ics, IName dn)
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<String>	listUsers(ICS ics) Lists all users (descendants of Properties.peopleParent)
Collection	listUsers(ICS ics, IName commonAncestor) Lists all users descended from a specified node.
Collection<String>	orSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with attributes matching any of those specified (OR); searches under Properties.baseDN
Collection<String>	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

doGroupSearch, doUserSearch, getGroupName, getID, getRequiredColumn, getSpecialAtts, getSystemUserAttrs, restoreVar, setVar, verifyIList

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.commons.logging.Log log

errorMessage

public static final String errorMessage

See Also:

Constant Field Values

Constructor Detail

CustomDir

public CustomDir(ICS ics)
          throws DirectoryException

Throws:

DirectoryException

CustomDir

public CustomDir(ICS ics,
                 IDir idir)
          throws DirectoryException

Throws:

DirectoryException

Method Detail

andSearch

public Collection<String> 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<String> 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

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

groupMembers

public Collection<String> 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.

groupMemberships

public Collection<String> 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.

groupMemberships_

public Collection<String> groupMemberships_(ICS ics,
                                            IName dn)
                                     throws DirectoryException

Throws:

DirectoryException

INameToCustomID

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

Throws:

DirectoryException

listUsers

public Collection<String> 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.

orSearch

public Collection<String> 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<String> 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

listUsers

public Collection listUsers(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

Overrides:

listUsers in class CSDir

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.

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

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.

create

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

Description copied from interface: IDir

Create an object.

Specified by:

create in interface IDir

Overrides:

create in class CSDir

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

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

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.

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

listGroups

public Collection listGroups(ICS ics)
                      throws DirectoryException

Description copied from interface: IUserDir

Lists all groups (descendants of Properties.groupParent)

Specified by:

listGroups in interface IUserDir

Overrides:

listGroups in class CSDir

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

Description copied from interface: IUserDir

Lists all groups descended from a specified node.

Specified by:

listGroups in interface IUserDir

Overrides:

listGroups in class CSDir

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 Collection children(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

Overrides:

children in class CSDir

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

Throws:

DirectoryException

addAttrs

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

Overrides:

addAttrs in class CSDir

Throws:

DirectoryException

deleteAttrs

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

Overrides:

deleteAttrs in class CSDir

Throws:

DirectoryException

groupHierarchicalMembers

public Collection groupHierarchicalMembers(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

Overrides:

groupHierarchicalMembers in class CSDir

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.

groupHierarchicalMemberships

public Collection groupHierarchicalMemberships(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

Overrides:

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

Throws:

DirectoryException - If there is an error.