org.forgerock.opendj.ldif

Class LdifEntryWriter

java.lang.Object

org.forgerock.opendj.ldif.LdifEntryWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, EntryWriter

public final class LdifEntryWriter
extends Object
implements EntryWriter

An LDIF entry writer writes attribute value records (entries) using the LDAP Data Interchange Format (LDIF) to a user defined destination.

See Also:

RFC 2849 - The LDAP Data Interchange Format (LDIF) - Technical Specification

Constructor Summary

Constructors

Constructor and Description
LdifEntryWriter(List<String> ldifLines) Creates a new LDIF entry writer which will append lines of LDIF to the provided list.
LdifEntryWriter(OutputStream out) Creates a new LDIF entry writer whose destination is the provided output stream.
LdifEntryWriter(Writer writer) Creates a new LDIF entry writer whose destination is the provided character stream writer.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this entry writer, flushing it first.
void	flush() Flushes this entry writer so that any buffered data is written immediately to underlying stream, flushing the stream if it is also Flushable.
LdifEntryWriter	setAddUserFriendlyComments(boolean addUserFriendlyComments) Specifies whether user-friendly comments should be added whenever distinguished names or UTF-8 attribute values are encountered which contained non-ASCII characters.
LdifEntryWriter	setExcludeAllOperationalAttributes(boolean excludeOperationalAttributes) Specifies whether all operational attributes should be excluded from any entries that are written to LDIF.
LdifEntryWriter	setExcludeAllUserAttributes(boolean excludeUserAttributes) Specifies whether all user attributes should be excluded from any entries that are written to LDIF.
LdifEntryWriter	setExcludeAttribute(AttributeDescription attributeDescription) Excludes the named attribute from any entries that are written to LDIF.
LdifEntryWriter	setExcludeBranch(Dn excludeBranch) Excludes all entries beneath the named entry (inclusive) from being written to LDIF.
LdifEntryWriter	setIncludeAttribute(AttributeDescription attributeDescription) Ensures that the named attribute is not excluded from any entries that are written to LDIF.
LdifEntryWriter	setIncludeBranch(Dn includeBranch) Ensures that all entries beneath the named entry (inclusive) are written to LDIF.
LdifEntryWriter	setIncludeExcludeFilters(Collection<Filter> includeFilters, Collection<Filter> excludeFilters) Sets the filters to include / exclude entries.
LdifEntryWriter	setWrapColumn(int wrapColumn) Specifies the column at which long lines should be wrapped.
static String	toString(Entry entry) Returns the LDIF string representation of the provided entry.
LdifEntryWriter	writeComment(CharSequence comment) Writes a comment.
LdifEntryWriter	writeEntry(Entry entry) Writes an entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

LdifEntryWriter

public LdifEntryWriter(List<String> ldifLines)

Creates a new LDIF entry writer which will append lines of LDIF to the provided list.

Parameters:

ldifLines - The list to which lines of LDIF should be appended.

LdifEntryWriter

public LdifEntryWriter(OutputStream out)

Creates a new LDIF entry writer whose destination is the provided output stream.

Parameters:

out - The output stream to use.

LdifEntryWriter

public LdifEntryWriter(Writer writer)

Creates a new LDIF entry writer whose destination is the provided character stream writer.

Parameters:

writer - The character stream writer to use.

Method Detail

toString

public static String toString(Entry entry)

Returns the LDIF string representation of the provided entry.

Parameters:

entry - The entry.

Returns:

The LDIF string representation of the provided entry.

close

public void close()
           throws IOException

Description copied from interface: EntryWriter

Closes this entry writer, flushing it first. Closing a previously closed entry writer has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EntryWriter

Throws:

IOException - If an unexpected IO error occurred while closing.

flush

public void flush()
           throws IOException

Description copied from interface: EntryWriter

Flushes this entry writer so that any buffered data is written immediately to underlying stream, flushing the stream if it is also Flushable.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Specified by:

flush in interface Flushable

Specified by:

flush in interface EntryWriter

Throws:

IOException - If an unexpected IO error occurred while flushing.

setAddUserFriendlyComments

public LdifEntryWriter setAddUserFriendlyComments(boolean addUserFriendlyComments)

Specifies whether user-friendly comments should be added whenever distinguished names or UTF-8 attribute values are encountered which contained non-ASCII characters. The default is false.

Parameters:

addUserFriendlyComments - true if user-friendly comments should be added, or false otherwise.

Returns:

A reference to this LdifEntryWriter.

setExcludeAllOperationalAttributes

public LdifEntryWriter setExcludeAllOperationalAttributes(boolean excludeOperationalAttributes)

Specifies whether all operational attributes should be excluded from any entries that are written to LDIF. The default is false.

Parameters:

excludeOperationalAttributes - true if all operational attributes should be excluded, or false otherwise.

Returns:

A reference to this LdifEntryWriter.

setExcludeAllUserAttributes

public LdifEntryWriter setExcludeAllUserAttributes(boolean excludeUserAttributes)

Specifies whether all user attributes should be excluded from any entries that are written to LDIF. The default is false.

Parameters:

excludeUserAttributes - true if all user attributes should be excluded, or false otherwise.

Returns:

A reference to this LdifEntryWriter.

setExcludeAttribute

public LdifEntryWriter setExcludeAttribute(AttributeDescription attributeDescription)

Excludes the named attribute from any entries that are written to LDIF. By default all attributes are included unless explicitly excluded.

Parameters:

attributeDescription - The name of the attribute to be excluded.

Returns:

A reference to this LdifEntryWriter.

setExcludeBranch

public LdifEntryWriter setExcludeBranch(Dn excludeBranch)

Excludes all entries beneath the named entry (inclusive) from being written to LDIF. By default all entries are written unless explicitly excluded or included by branches or filters.

Parameters:

excludeBranch - The distinguished name of the branch to be excluded.

Returns:

A reference to this LdifEntryWriter.

setIncludeAttribute

public LdifEntryWriter setIncludeAttribute(AttributeDescription attributeDescription)

Ensures that the named attribute is not excluded from any entries that are written to LDIF. By default all attributes are included unless explicitly excluded.

Parameters:

attributeDescription - The name of the attribute to be included.

Returns:

A reference to this LdifEntryWriter.

setIncludeBranch

public LdifEntryWriter setIncludeBranch(Dn includeBranch)

Ensures that all entries beneath the named entry (inclusive) are written to LDIF. By default all entries are written unless explicitly excluded or included by branches or filters.

Parameters:

includeBranch - The distinguished name of the branch to be included.

Returns:

A reference to this LdifEntryWriter.

setIncludeExcludeFilters

public LdifEntryWriter setIncludeExcludeFilters(Collection<Filter> includeFilters,
                                                Collection<Filter> excludeFilters)

Sets the filters to include / exclude entries. By default all entries are read unless explicitly excluded or included by branches or filters.

Parameters:

includeFilters - entries which match any include filter will be included from LDIF.

excludeFilters - entries which match any exclude filter will be excluded from LDIF.

Returns:

A reference to this LdifEntryReader.

setWrapColumn

public LdifEntryWriter setWrapColumn(int wrapColumn)

Specifies the column at which long lines should be wrapped. A value less than or equal to zero (the default) indicates that no wrapping should be performed.

Parameters:

wrapColumn - The column at which long lines should be wrapped.

Returns:

A reference to this LdifEntryWriter.

writeComment

public LdifEntryWriter writeComment(CharSequence comment)
                             throws IOException

Description copied from interface: EntryWriter

Writes a comment.

Specified by:

writeComment in interface EntryWriter

Parameters:

comment - The CharSequence to be written as a comment.

Returns:

A reference to this entry writer.

Throws:

IOException - If an unexpected IO error occurred while writing the comment.

writeEntry

public LdifEntryWriter writeEntry(Entry entry)
                           throws IOException

Description copied from interface: EntryWriter

Writes an entry.

Specified by:

writeEntry in interface EntryWriter

Parameters:

entry - The Entry to be written.

Returns:

A reference to this entry writer.

Throws:

IOException - If an unexpected IO error occurred while writing the entry.