Package org.bedework.util.directory.ldif

Class Ldif

java.lang.Object

org.bedework.util.directory.common.Directory

org.bedework.util.directory.ldif.Ldif

All Implemented Interfaces:

org.bedework.util.logging.Logged

public class Ldif
extends Directory

This class provides methods to read ldif data from an input stream. The stream is considered to be broken up into lines, starting at line 1 each of which contains an ldif item, start of attribute + value, continuation or record terminator (null line). Methods allow us to position in the stream, read an entire ldif record, or convert a record to a tabular form for processing. Various Directory methods probably have no meaning here, searches will typically fail with an exception or be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ldif.LdifOut	LdifOut - out method is called to write ldif output

Field Summary

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

scopeBase, scopeOne, scopeSub

Constructor Summary

Constructors

Constructor	Description
Ldif()	Constructor required so we can instantiate object dynamically
Ldif(File f)
Ldif(InputStream in)
Ldif(String fileName)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	create(DirRecord rec)
void	destroy(String dn)
static void	dumpAttr(Ldif.LdifOut lo, Attribute a)
static void	dumpLdif(Ldif.LdifOut lo, DirRecord rec)	dumpLdif write the entire record as ldif.
org.bedework.util.logging.BwLogger	getLogger()
void	modify(String dn, ModificationItem[] mods)
DirRecord	nextRecord()	Return the next record in the input stream.
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 dn, String filter, int scope)	search

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

Ldif

public Ldif()
     throws Exception

Constructor required so we can instantiate object dynamically

Throws:

Exception

Ldif

public Ldif(String fileName)
     throws Exception

Throws:

Exception

Ldif

public Ldif(File f)
     throws Exception

Throws:

Exception

Ldif

public Ldif(InputStream in)
     throws Exception

Throws:

Exception

Method Detail

reInit

public void reInit()

Description copied from class: Directory

If possible, reInit should allow reuse after a close

Specified by:

reInit in class Directory

destroy

public void destroy(String dn)
             throws NamingException

Specified by:

destroy in class Directory

Throws:

NamingException - on fatal error

search

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

search

Specified by:

search in class Directory

Parameters:

dn - Used as the pathname

filter - Ignored

scope - Ignored

Returns:

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

Throws:

NamingException

nextRecord

public DirRecord nextRecord()
                     throws NamingException

Return the next record in the input stream.

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

dumpLdif

public static void dumpLdif(Ldif.LdifOut lo,
                            DirRecord rec)
                     throws NamingException

dumpLdif write the entire record as ldif.

Throws:

NamingException

dumpAttr

public static void dumpAttr(Ldif.LdifOut lo,
                            Attribute a)
                     throws NamingException

Throws:

NamingException

close

public void close()

Specified by:

close in class Directory

getLogger

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