com.openmarket.directory.jndi

Class JNDIDir

java.lang.Object

com.openmarket.directory.jndi.JNDIDir

All Implemented Interfaces:

IDir

Direct Known Subclasses:

JNDIAuthDir

public class JNDIDir
extends Object
implements IDir

Supports the dir tagsets. Refer to that documentation for the values set for errno. It is assumed by this class that NameWrapper is the IName implementation. Use the DirProperties.classJNDIName property to configure the implementing class for NameWrapper.

See Also:

NameWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JNDIDir.SupportingData

Constructor Summary

Constructors

Constructor and Description
JNDIDir(ICS ics) Initializes ObjectPool of DirContext instances, if pooling is enabled

Method Summary

Modifier and Type	Method and Description
void	addAttrs(ICS ics, IName dn, Attributes attributes) Add attributes to an existing entry.
Collection	andSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND); searches under DirProperties.baseDN
Collection	andSearch(ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries with matching attributes (AND)
protected void	attrsOp(ICS ics, IName dn, int op, Attributes attributes)
protected static String	authtMech(ICS ics) Do *not* use this to set the authentication mechanism.
Collection	children(ICS ics, IName dn) Retrieves the immediate child entries of the specified parent.
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.
protected boolean	DNExists(ICS ics, IName dn) Ensure that the Distinguished name exists in the directory.
protected static IName	fullName(ICS ics, IName name) Clone the name and prepend the basedn to it
Attributes	getAttrs(ICS ics, IName dn, String[] attrIds) Retrieve the specified attributes from the specified entry.
protected static IName	getBaseDN(ICS ics) Look up the baseDN in the object pool, if not there, create it from the string in the property file.
Attributes	getGroupAttributes(ICS ics, String groupname, Attributes attributes)
protected com.openmarket.directory.jndi.JNDIInterface	getJNDIInterface(ICS ics)
Attributes	getUserAttributes(ICS ics, String name, Attributes attributes)
protected static void	handleNamingException(ICS ics, NamingException e, JNDIDir.SupportingData data, String className, String methodName) Added by Yu-Chun to call the modified handleNamingException() with throwException=true
protected static void	handleNamingException(ICS ics, NamingException e, JNDIDir.SupportingData data, String className, String methodName, boolean throwException) The JNDI interface doesn't specify every type of Exception that might be thrown by a particular method.
protected static int	intPropertyValue(ICS ics, String propName)
protected boolean	isMember(ICS ics, IName member, IName group) Member is a name relative to baseDN
protected static Collection	membersToCollection(ICS ics, Attribute attr) Don't use toCollection here because the Enumeration is of Objects (Strings) not NameClassPair's.
protected Attributes	mimeEncodedPropToAttributes(ICS ics, String propname)
protected List	mimeEncodedPropToNameList(ICS ics, String propname)
protected Collection	opSearch(ICS ics, IName parent, Attributes matchingAttributes, String op)
Collection	orSearch(ICS ics, Attributes matchingAttributes) Simple search returns all entries with attributes matching any of those specified (OR); searches under DirProperties.baseDN
Collection	orSearch(ICS ics, IName parent, Attributes matchingAttributes) Simple search returns all entries attributes matching any of those specified (OR)
protected static String	principal(ICS ics) Returns the principal being used for JNDI SPI access, whether it be the current user or something configured in the property file.
protected static IName	relativeName(ICS ics, IName fName) Clone the name and chop the basedn off it.
void	replaceAttrs(ICS ics, IName dn, Attributes attributes) Replace the existing attribute value(s) with the specified value(s).
protected static Collection	toCollection(ICS ics, NamingEnumeration nEnum)
protected static Collection	toCollection(ICS ics, NamingEnumeration nEnum, IName prefix)
protected Attribute	uniquememberAttr(ICS ics, IName group) returns null if uniquemember attribute is not found.

Methods inherited from class java.lang.Object

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

Constructor Detail

JNDIDir

public JNDIDir(ICS ics)

Initializes ObjectPool of DirContext instances, if pooling is enabled

Method Detail

authtMech

protected static String authtMech(ICS ics)
                           throws DirectoryException

Do *not* use this to set the authentication mechanism. This is strictly a utility for logging.

Throws:

DirectoryException

principal

protected static String principal(ICS ics)
                           throws DirectoryException

Returns the principal being used for JNDI SPI access, whether it be the current user or something configured in the property file.

Throws:

DirectoryException

getJNDIInterface

protected com.openmarket.directory.jndi.JNDIInterface getJNDIInterface(ICS ics)
                                                                throws DirectoryException

Throws:

DirectoryException

handleNamingException

protected static void handleNamingException(ICS ics,
                                            NamingException e,
                                            JNDIDir.SupportingData data,
                                            String className,
                                            String methodName)
                                     throws DirectoryException

Added by Yu-Chun to call the modified handleNamingException() with throwException=true

Parameters:

ics -

e -

data -

className -

methodName -

Throws:

DirectoryException

handleNamingException

protected static void handleNamingException(ICS ics,
                                            NamingException e,
                                            JNDIDir.SupportingData data,
                                            String className,
                                            String methodName,
                                            boolean throwException)
                                     throws DirectoryException

The JNDI interface doesn't specify every type of Exception that might be thrown by a particular method. Catch what you can in the calling method, and catch NamingException last. In that last catch, send the exception to this method for more detailed error interpretation.

Errors are translated to an end-user-friendly message which is logged as an error, and a trace message is logged containing the less user-friendly exception detail. 08/20/2014 Method modified by Yu-Chun to handle the throwException logic

Throws:

DirectoryException

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

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

dn - Distinguished name of entry to be deleted.

Throws:

DirectoryException

intPropertyValue

protected static int intPropertyValue(ICS ics,
                                      String propName)
                               throws DirectoryException

Throws:

DirectoryException

toCollection

protected static Collection toCollection(ICS ics,
                                         NamingEnumeration nEnum)

toCollection

protected static Collection toCollection(ICS ics,
                                         NamingEnumeration nEnum,
                                         IName prefix)

opSearch

protected Collection opSearch(ICS ics,
                              IName parent,
                              Attributes matchingAttributes,
                              String op)
                       throws DirectoryException

Throws:

DirectoryException

andSearch

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

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

Specified by:

andSearch in interface IDir

Parameters:

matchingAttributes - The name value pairs to match

Returns:

Collection of distinguished names (Strings). Throws exception if none found.

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

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

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

Specified by:

orSearch in interface IDir

Parameters:

matchingAttributes - The name value pairs to match

Returns:

Collection of distinguished names (Strings). Throws exception if none found.

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

parent - The entry under which to search

matchingAttributes - The name value pairs to match

Throws:

DirectoryException

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

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

Throws:

DirectoryException

attrsOp

protected void attrsOp(ICS ics,
                       IName dn,
                       int op,
                       Attributes attributes)
                throws DirectoryException

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

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

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

attributes - Attributes to be removed.

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

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

uniquememberAttr

protected Attribute uniquememberAttr(ICS ics,
                                     IName group)
                              throws DirectoryException

returns null if uniquemember attribute is not found. Returns the full DN, including the BaseDN

Throws:

DirectoryException

getBaseDN

protected static IName getBaseDN(ICS ics)
                          throws DirectoryException

Look up the baseDN in the object pool, if not there, create it from the string in the property file.

Throws:

DirectoryException

fullName

protected static IName fullName(ICS ics,
                                IName name)
                         throws DirectoryException

Clone the name and prepend the basedn to it

Throws:

DirectoryException

relativeName

protected static IName relativeName(ICS ics,
                                    IName fName)
                             throws DirectoryException

Clone the name and chop the basedn off it. Returns null if name not relative.

Throws:

DirectoryException

isMember

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

Member is a name relative to baseDN

Throws:

DirectoryException

membersToCollection

protected static Collection membersToCollection(ICS ics,
                                                Attribute attr)
                                         throws DirectoryException

Don't use toCollection here because the Enumeration is of Objects (Strings) not NameClassPair's. Additionally, you have to strip off the BaseDN from each DN.

Throws:

DirectoryException

DNExists

protected boolean DNExists(ICS ics,
                           IName dn)

Ensure that the Distinguished name exists in the directory.

getUserAttributes

public Attributes getUserAttributes(ICS ics,
                                    String name,
                                    Attributes attributes)
                             throws DirectoryException

Throws:

DirectoryException

getGroupAttributes

public Attributes getGroupAttributes(ICS ics,
                                     String groupname,
                                     Attributes attributes)
                              throws DirectoryException

Throws:

DirectoryException

mimeEncodedPropToAttributes

protected Attributes mimeEncodedPropToAttributes(ICS ics,
                                                 String propname)
                                          throws DirectoryException

Throws:

DirectoryException

mimeEncodedPropToNameList

protected List mimeEncodedPropToNameList(ICS ics,
                                         String propname)