Package org.forgerock.opendj.ldif

Class LdifEntryWriter

    • 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 AutoCloseable
        Specified by:
        close in interface Closeable
        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 EntryWriter
        Specified by:
        flush in interface Flushable
        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.

      • 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.

      • getSkippedCount

        public long getSkippedCount()
        Returns the number of entries provided to writeEntry(Entry) which have been ignored because they were excluded by the writer's filtering configuration.
        Returns:
        the number of skipped entries

      • getWrittenCount

        public long getWrittenCount()
        Returns the number of entries provided to writeEntry(Entry) which have been written to the LDIF output file.
        Returns:
        the number of entries written to the LDIF output file