org.dataone.cn.ldap

Class LDAPService

java.lang.Object

org.dataone.cn.ldap.LDAPService

public abstract class LDAPService
extends Object

Base LDAP class for shared LDAP operations. Intended to be used by the Identity Manager and the Identifier Reservation systems Also used by Cn Node Registry

Author:

leinfelder

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LDAPService()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addCountry(DirContext ctx, String dn) Adds the country branch of the given DN to the Context.
protected boolean	addDc(DirContext ctx, String dn) Adds the DC branch of the given DN to the Context.
protected boolean	addOrg(DirContext ctx, String dn) Adds the organization branch of the given DN to the Context.
protected boolean	addOrgUnit(DirContext ctx, String dn) Adds the organization unit of the given DN to the Context.
protected boolean	checkAttribute(DirContext ctx, String dn, String attributeName, String attributeValue) check the attribute for a given subject
protected boolean	constructTree(DirContext ctx, String dn) Constructs the necessary LDAP tree for the given DN Assuming CILogon format: "CN=Benjamin Leinfelder A515,O=University of Chicago,C=US,DC=cilogon,DC=org" or LDAP format: "uid=kepler,o=unaffiliated,dc=ecoinformatics,dc=org"
protected List<Object>	getAttributeValues(DirContext ctx, String dn, String attributeName)
String	getBase()
String	getEnumerationValueString(NamingEnumeration namingEnum) return the next value of a NamingEnumeration, or empty String if there are not any more.
protected String	parseAttribute(String original, String attribute)
protected boolean	removeEntry(DirContext ctx, String dn)
void	setBase(String base)

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

Constructor Detail

LDAPService

public LDAPService()

Method Detail

removeEntry

protected boolean removeEntry(DirContext ctx,
                  String dn)

checkAttribute

protected boolean checkAttribute(DirContext ctx,
                     String dn,
                     String attributeName,
                     String attributeValue)

check the attribute for a given subject

Parameters:

dn -

attributeName -

attributeValue -

Returns:

See Also:

for considerations on special characters

getAttributeValues

protected List<Object> getAttributeValues(DirContext ctx,
                              String dn,
                              String attributeName)
                                   throws NamingException

Throws:

NamingException

parseAttribute

protected String parseAttribute(String original,
                    String attribute)

constructTree

protected boolean constructTree(DirContext ctx,
                    String dn)
                         throws NamingException

Constructs the necessary LDAP tree for the given DN Assuming CILogon format: "CN=Benjamin Leinfelder A515,O=University of Chicago,C=US,DC=cilogon,DC=org" or LDAP format: "uid=kepler,o=unaffiliated,dc=ecoinformatics,dc=org"

Parameters:

dn - the full DN from CILogon

Returns:

true if successfully added

Throws:

NamingException

addOrg

protected boolean addOrg(DirContext ctx,
             String dn)
                  throws NamingException

Adds the organization branch of the given DN to the Context. For example, "O=University of Chicago,C=US,DC=cilogon,DC=org", add "O=University of Chicago" to "DC=cilogon,DC=org"

Parameters:

dn: - the DN for the Organization being added

Returns:

true if added sucessfully

Throws:

NamingException

addOrgUnit

protected boolean addOrgUnit(DirContext ctx,
                 String dn)
                      throws NamingException

Adds the organization unit of the given DN to the Context. For example, "OU=Account,DC=ecoinformatics,DC=org", add "OU=Account" to "DC=ecoinformatics,DC=org"

Parameters:

dn: - the DN for the Organizational Unit being added

Returns:

true if added sucessfully

Throws:

NamingException

addDc

protected boolean addDc(DirContext ctx,
            String dn)
                 throws NamingException

Adds the DC branch of the given DN to the Context. For example, "DC=ecoinformatics,DC=org", add ""DC=ecoinformatics" to "DC=org"

Parameters:

dn: - the DN for the DC being added

Returns:

true if added successfully

Throws:

NamingException

addCountry

protected boolean addCountry(DirContext ctx,
                 String dn)
                      throws NamingException

Adds the country branch of the given DN to the Context. for example: "C=US,DC=cilogon,DC=org" adds 'C=US' to 'DC=cilogon,DC=org'

Parameters:

dn - the DN of the country being added

Returns:

true if added successfully

Throws:

NamingException

getEnumerationValueString

public String getEnumerationValueString(NamingEnumeration namingEnum)
                                 throws NamingException

return the next value of a NamingEnumeration, or empty String if there are not any more. (Guaranteed not to return null).

Parameters:

namingEnum -

Returns:

Throws:

NamingException

getBase

public String getBase()

setBase

public void setBase(String base)