Package com.unboundid.ldap.sdk.unboundidds.tools

Class ColumnBasedLDAPResultWriter

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.tools.LDAPResultWriter

com.unboundid.ldap.sdk.unboundidds.tools.ColumnBasedLDAPResultWriter

@ThreadSafety(level=NOT_THREADSAFE)
public final class ColumnBasedLDAPResultWriter
extends LDAPResultWriter

This class provides an LDAPResultWriter instance that uses a ColumnFormatter to output search result entries in a format like CSV or tab-delimited text. Only a single value from each attribute will be used, and an empty string will be used for attributes without any values.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Constructor Summary

Constructors

Constructor	Description
ColumnBasedLDAPResultWriter(OutputStream outputStream, OutputFormat outputFormat, List<String> requestedAttributes, int maxCommentWidth, boolean includeAllValues)	Creates a new instance of this LDAP result writer.

Method Summary

Modifier and Type	Method	Description
void	writeComment(String comment)	Writes the provided comment to the output.
void	writeHeader()	Formats and writes a header that describes the way in which the data will be formatted.
void	writeResult(LDAPResult result)	Formats and writes the provided LDAP result.
void	writeSearchResultEntry(SearchResultEntry entry)	Formats and writes the provided search result entry.
void	writeSearchResultReference(SearchResultReference ref)	Formats and writes the provided search result reference.
void	writeUnsolicitedNotification(LDAPConnection connection, ExtendedResult notification)	Formats and writes the provided unsolicited notification.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tools.LDAPResultWriter

flush, getPrintStream, print, println, println, updateOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

ColumnBasedLDAPResultWriter

public ColumnBasedLDAPResultWriter(@NotNull
 OutputStream outputStream,
 @NotNull
 OutputFormat outputFormat,
 @NotNull
 List<String> requestedAttributes,
 int maxCommentWidth,
 boolean includeAllValues)

Creates a new instance of this LDAP result writer.

Parameters:

outputStream - The output stream to which the

outputFormat - The output format to use for search entry attributes.

requestedAttributes - The names of the requested attributes.

maxCommentWidth - The maximum width to use for comments in the output. This will be ignored for information about search result entries.

includeAllValues - Indicates whether to include all values of a multivalued attribute. If this is true, then a vertical bar (|) will be used to separate the values within each field.

Method Details

writeComment

public void writeComment(@NotNull
 String comment)

Writes the provided comment to the output.

Specified by:

writeComment in class LDAPResultWriter

Parameters:

comment - The comment to be written. It must not be null.

writeHeader

public void writeHeader()

Formats and writes a header that describes the way in which the data will be formatted. This will be displayed at the beginning of the output (including at the beginning of each file, if output should be spread across multiple files).

Specified by:

writeHeader in class LDAPResultWriter

writeSearchResultEntry

public void writeSearchResultEntry(@NotNull
 SearchResultEntry entry)

Formats and writes the provided search result entry.

Specified by:

writeSearchResultEntry in class LDAPResultWriter

Parameters:

entry - The search result entry to be processed.

writeSearchResultReference

public void writeSearchResultReference(@NotNull
 SearchResultReference ref)

Formats and writes the provided search result reference.

Specified by:

writeSearchResultReference in class LDAPResultWriter

Parameters:

ref - The search result reference to be processed.

writeResult

public void writeResult(@NotNull
 LDAPResult result)

Formats and writes the provided LDAP result.

Specified by:

writeResult in class LDAPResultWriter

Parameters:

result - The LDAP result to be processed. It may or may not be a search result.

writeUnsolicitedNotification

public void writeUnsolicitedNotification(@NotNull
 LDAPConnection connection,
 @NotNull
 ExtendedResult notification)

Formats and writes the provided unsolicited notification.

Specified by:

writeUnsolicitedNotification in class LDAPResultWriter

Parameters:

connection - The connection on which the unsolicited notification was received.

notification - The unsolicited notification that was received.