Package org.ldaptive.io

Class LdifWriter

java.lang.Object

org.ldaptive.io.LdifWriter

All Implemented Interfaces:

SearchResultWriter

public class LdifWriter
extends Object
implements SearchResultWriter

Writes a SearchResponse as LDIF to a Writer.

Field Summary

Fields

Modifier and Type	Field	Description
private final Writer	ldifWriter	Writer to write to.
private static final String	LINE_SEPARATOR	Line separator.

Constructor Summary

Constructors

Constructor	Description
LdifWriter(Writer writer)	Creates a new ldif writer.

Method Summary

Modifier and Type	Method	Description
protected String	createLdif(SearchResponse result)	Creates an LDIF using the supplied search result.
protected String	createLdifEntry(LdapEntry entry)	Creates an LDIF using the supplied ldap entry.
protected String	createSearchReference(SearchResultReference ref)	Creates an LDIF using the supplied search reference.
void	write(SearchResponse result)	Writes the supplied search result to the writer.

Methods inherited from class java.lang.Object

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

Field Details

LINE_SEPARATOR

private static final String LINE_SEPARATOR

Line separator.

ldifWriter

private final Writer ldifWriter

Writer to write to.

Constructor Details

LdifWriter

public LdifWriter(Writer writer)

Creates a new ldif writer.

Parameters:

writer - to write LDIF to

Method Details

write

public void write(SearchResponse result)
           throws IOException

Writes the supplied search result to the writer.

Specified by:

write in interface SearchResultWriter

Parameters:

result - search result to write

Throws:

IOException - if an error occurs using the writer

createLdif

protected String createLdif(SearchResponse result)

Creates an LDIF using the supplied search result.

Parameters:

result - search result

Returns:

LDIF

createLdifEntry

protected String createLdifEntry(LdapEntry entry)

Creates an LDIF using the supplied ldap entry.

Parameters:

entry - ldap entry

Returns:

LDIF

createSearchReference

protected String createSearchReference(SearchResultReference ref)

Creates an LDIF using the supplied search reference.

Parameters:

ref - search reference

Returns:

LDIF