Package org.bedework.util.directory.ldap

Class LdapDirectory

java.lang.Object

org.bedework.util.directory.common.Directory

org.bedework.util.directory.ldap.LdapDirectory

All Implemented Interfaces:

org.bedework.util.logging.Logged

public class LdapDirectory
extends Directory

Provide access to ldap directory services. If the object is provided with a Properties object it will be queried for a number of properties. If they are absent or no Properties object is provided they will default to some value. Properties are defined in javax.naming.Context and are: java.naming.factory.initial java.naming.provider.url Service provider, e.g. ldap://ldap.myhost.edu:389 java.naming.security.authentication e.g. "simple" java.naming.security.principal e.g. cn=dirManager java.naming.security.credentials Usually the password

Field Summary

Fields inherited from class org.bedework.util.directory.common.Directory

scopeBase, scopeOne, scopeSub

Constructor Summary

Constructors

Constructor	Description
LdapDirectory()	Constructor required so we can instantiate object dynamically
LdapDirectory(Properties pr, String mngrDN, String pw)

Method Summary

Modifier and Type	Method	Description
String	checkProp(Properties pr, String name, String defaultVal)	If the named property is present and has a value use that.
void	close()
boolean	create(DirRecord rec)
void	destroy(String dn)
Properties	getEnvironment()
org.bedework.util.logging.BwLogger	getLogger()
void	init(Properties pr, String mngrDN, String pw)
void	modify(String dn, ModificationItem[] mods)
DirRecord	nextRecord()
void	reInit()	If possible, reInit should allow reuse after a close
void	replace(String dn, String attrName, Object val)	Replace an entire attribute with one containing only the given value
void	replace(String dn, String attrName, Object[] val)	Replace an entire attribute with one containing only the given values
void	replace(String dn, String attrName, Object oldval, Object newval)	Replace a single given attribute value with the given value
boolean	search(String base, String filter, int scope)	Carry out a search with specified scope.

Methods inherited from class org.bedework.util.directory.common.Directory

newRecord, search, searchBase, searchOne

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, warn

Constructor Detail

LdapDirectory

public LdapDirectory()
              throws Exception

Constructor required so we can instantiate object dynamically

Throws:

Exception

LdapDirectory

public LdapDirectory(Properties pr,
                     String mngrDN,
                     String pw)
              throws NamingException

Parameters:

pr -

mngrDN -

pw -

Throws:

NamingException

Method Detail

init

public void init(Properties pr,
                 String mngrDN,
                 String pw)
          throws NamingException

Throws:

NamingException

reInit

public void reInit()
            throws NamingException

Description copied from class: Directory

If possible, reInit should allow reuse after a close

Specified by:

reInit in class Directory

Throws:

NamingException - on fatal error

destroy

public void destroy(String dn)
             throws NamingException

Specified by:

destroy in class Directory

Throws:

NamingException - on fatal error

search

public boolean search(String base,
                      String filter,
                      int scope)
               throws NamingException

Description copied from class: Directory

Carry out a search with specified scope.

Specified by:

search in class Directory

Parameters:

base - for search

filter - ldap filter

Returns:

false means no record(s) found. true means it's safe to call nextRecord.

Throws:

NamingException

nextRecord

public DirRecord nextRecord()
                     throws NamingException

Specified by:

nextRecord in class Directory

Throws:

NamingException

create

public boolean create(DirRecord rec)
               throws NamingException

Specified by:

create in class Directory

Parameters:

rec - directory record

Returns:

boolean true if created, false if already exists

Throws:

NamingException - on fatal error

replace

public void replace(String dn,
                    String attrName,
                    Object val)
             throws NamingException

Description copied from class: Directory

Replace an entire attribute with one containing only the given value

Specified by:

replace in class Directory

Parameters:

dn - for record

attrName - name of attribute

val - new value

Throws:

NamingException - on fatal error

replace

public void replace(String dn,
                    String attrName,
                    Object[] val)
             throws NamingException

Description copied from class: Directory

Replace an entire attribute with one containing only the given values

Specified by:

replace in class Directory

Parameters:

dn - for record

attrName - name of attribute

val - new value

Throws:

NamingException - on fatal error

replace

public void replace(String dn,
                    String attrName,
                    Object oldval,
                    Object newval)
             throws NamingException

Description copied from class: Directory

Replace a single given attribute value with the given value

Specified by:

replace in class Directory

Parameters:

dn - for record

attrName - name of attribute

oldval - current value

newval - new value

Throws:

NamingException - on fatal error

modify

public void modify(String dn,
                   ModificationItem[] mods)
            throws NamingException

Specified by:

modify in class Directory

Parameters:

dn - for record

mods - list of changes

Throws:

NamingException - on fatal error

getEnvironment

public Properties getEnvironment()
                          throws NamingException

Throws:

NamingException

close

public void close()

Specified by:

close in class Directory

checkProp

public String checkProp(Properties pr,
                        String name,
                        String defaultVal)

If the named property is present and has a value use that. Otherwise, set the value to the given default and use that.

Parameters:

pr -

name -

defaultVal -

Returns:

String

getLogger

public org.bedework.util.logging.BwLogger getLogger()