org.bedework.util.directory.common

Class Directory

java.lang.Object

org.bedework.util.misc.Logged

org.bedework.util.directory.common.Directory

Direct Known Subclasses:

Ldif

public abstract class Directory
extends Logged

Provide access to 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.example.com:389 java.naming.security.authentication e.g. "simple" java.naming.security.principal e.g. cn=dirManager java.naming.security.credentials Usually the password The intention is that this class should be able to represent various forms of directory, even a sequential input stream of records.

Field Summary

Fields

Modifier and Type	Field and Description
static int	scopeBase These define the values used for scope parameters
static int	scopeOne
static int	scopeSub

Fields inherited from class org.bedework.util.misc.Logged

debug

Constructor Summary

Constructors

Constructor and Description
Directory() All other constructors just call init
Directory(String mngrDN, String pw)

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract void	create(DirRecord rec)
abstract void	destroy(String dn)
abstract void	modify(String dn, ModificationItem[] mods)
DirRecord	newRecord(String entryDn) newRecord - Return a record which can have attribute values added.
abstract DirRecord	nextRecord()
abstract void	reInit() If possible, reInit should allow reuse after a close
abstract void	replace(String dn, String attrName, Object val) Replace an entire attribute with one containing only the given value
abstract void	replace(String dn, String attrName, Object[] val) Replace an entire attribute with one containing only the given values
abstract 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) Carry out a subtree search
abstract boolean	search(String base, String filter, int scope) Carry out a search with specified scope.
boolean	searchBase(String base, String filter) Carry out a base level search.
boolean	searchOne(String base, String filter) Carry out a one level search

Methods inherited from class org.bedework.util.misc.Logged

debug, error, error, getLogger, info, warn

Methods inherited from class java.lang.Object

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

Field Detail

scopeBase

public static final int scopeBase

These define the values used for scope parameters

See Also:

Constant Field Values

scopeOne

public static final int scopeOne

See Also:

Constant Field Values

scopeSub

public static final int scopeSub

See Also:

Constant Field Values

Constructor Detail

Directory

public Directory()
          throws Exception

All other constructors just call init

Throws:

Exception

Directory

public Directory(String mngrDN,
                 String pw)
          throws Exception

Throws:

Exception

Method Detail

reInit

public abstract void reInit()
                     throws Exception

If possible, reInit should allow reuse after a close

Throws:

Exception

destroy

public abstract void destroy(String dn)
                      throws Exception

Throws:

Exception

search

public boolean search(String base,
                      String filter)
               throws Exception

Carry out a subtree search

Throws:

Exception

searchBase

public boolean searchBase(String base,
                          String filter)
                   throws Exception

Carry out a base level search. This should be the default if the scope is not specified.

Throws:

Exception

searchOne

public boolean searchOne(String base,
                         String filter)
                  throws Exception

Carry out a one level search

Throws:

Exception

search

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

Carry out a search with specified scope.

Returns:

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

Throws:

Exception

nextRecord

public abstract DirRecord nextRecord()
                              throws Exception

Throws:

Exception

newRecord

public DirRecord newRecord(String entryDn)
                    throws NamingException

newRecord - Return a record which can have attribute values added. create should be called to create the directory entry.

Throws:

NamingException

create

public abstract void create(DirRecord rec)
                     throws Exception

Throws:

Exception

replace

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

Replace an entire attribute with one containing only the given value

Throws:

Exception

replace

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

Replace an entire attribute with one containing only the given values

Throws:

Exception

replace

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

Replace a single given attribute value with the given value

Throws:

Exception

modify

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

Throws:

Exception

close

public abstract void close()