Class 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 Detail

      • ColumnBasedLDAPResultWriter

        public ColumnBasedLDAPResultWriter​(@NotNull
                                           java.io.OutputStream outputStream,
                                           @NotNull
                                           OutputFormat outputFormat,
                                           @NotNull
                                           java.util.List<java.lang.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.