Package org.forgerock.opendj.ldif

Class LDIFEntryReader

java.lang.Object
org.forgerock.opendj.ldif.LDIFEntryReader
All Implemented Interfaces:
Closeable, AutoCloseable, EntryReader
public final class LDIFEntryReader extends Object implements EntryReader
An LDIF entry reader reads attribute value records (entries) using the LDAP Data Interchange Format (LDIF) from a user defined source.
See Also:

  • Constructor Details

    • LDIFEntryReader

      public LDIFEntryReader(InputStream in)
      Creates a new LDIF entry reader whose source is the provided input stream.
      Parameters:
      in - The input stream to use.
      Throws:
      NullPointerException - If in was null.

    • LDIFEntryReader

      public LDIFEntryReader(List<String> ldifLines)
      Creates a new LDIF entry reader which will read lines of LDIF from the provided list of LDIF lines.
      Parameters:
      ldifLines - The lines of LDIF to be read.
      Throws:
      NullPointerException - If ldifLines was null.

    • LDIFEntryReader

      public LDIFEntryReader(Reader reader)
      Creates a new LDIF entry reader whose source is the provided character stream reader.
      Parameters:
      reader - The character stream reader to use.
      Throws:
      NullPointerException - If reader was null.

    • LDIFEntryReader

      public LDIFEntryReader(String... ldifLines)
      Creates a new LDIF entry reader which will read lines of LDIF from the provided array of LDIF lines.
      Parameters:
      ldifLines - The lines of LDIF to be read.
      Throws:
      NullPointerException - If ldifLines was null.

  • Method Details

    • valueOfLDIFEntry

      public static Entry valueOfLDIFEntry(String... ldifLines)
      Parses the provided array of LDIF lines as a single LDIF entry.
      Parameters:
      ldifLines - The lines of LDIF to be parsed.
      Returns:
      The parsed LDIF entry.
      Throws:
      org.forgerock.i18n.LocalizedIllegalArgumentException - If ldifLines did not contain an LDIF entry, if it contained multiple entries, if contained malformed LDIF, or if the entry could not be decoded using the default schema.
      NullPointerException - If ldifLines was null.

    • close

      public void close() throws IOException
      Description copied from interface: EntryReader
      Closes this entry reader if it is not already closed. Note that this method does not need to be called if a previous call of EntryReader.readEntry() has returned null.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface EntryReader
      Throws:
      IOException - If an unexpected IO error occurred while closing.

    • hasNext

      public boolean hasNext() throws DecodeException, IOException
      Returns true if this reader contains another entry, blocking if necessary until either the next entry is available or the end of the stream is reached.
      Specified by:
      hasNext in interface EntryReader
      Returns:
      true if this reader contains another entry.
      Throws:
      DecodeException - If the entry could not be decoded because it was malformed.
      IOException - If an unexpected IO error occurred.

    • readEntry

      public Entry readEntry() throws DecodeException, IOException
      Reads the next entry, blocking if necessary until an entry is available.
      Specified by:
      readEntry in interface EntryReader
      Returns:
      The next entry.
      Throws:
      DecodeException - If the entry could not be decoded because it was malformed.
      IOException - If an unexpected IO error occurred while reading the entry.

    • setExcludeAllOperationalAttributes

      public LDIFEntryReader setExcludeAllOperationalAttributes(boolean excludeOperationalAttributes)
      Specifies whether all operational attributes should be excluded from any entries that are read from LDIF. The default is false.
      Parameters:
      excludeOperationalAttributes - true if all operational attributes should be excluded, or false otherwise.
      Returns:
      A reference to this LDIFEntryReader.

    • setExcludeAllUserAttributes

      public LDIFEntryReader setExcludeAllUserAttributes(boolean excludeUserAttributes)
      Specifies whether all user attributes should be excluded from any entries that are read from LDIF. The default is false.
      Parameters:
      excludeUserAttributes - true if all user attributes should be excluded, or false otherwise.
      Returns:
      A reference to this LDIFEntryReader.

    • setExcludeAttribute

      public LDIFEntryReader setExcludeAttribute(AttributeDescription attributeDescription)
      Excludes the named attribute from any entries that are read from 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 LDIFEntryReader.

    • setExcludeBranch

      public LDIFEntryReader setExcludeBranch(DN excludeBranch)
      Excludes all entries beneath the named entry (inclusive) from being read from 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 LDIFEntryReader.

    • setExcludeFilter

      public LDIFEntryReader setExcludeFilter(Matcher excludeFilter)
      Excludes all entries which match the provided filter matcher from being read from LDIF. By default all entries are read unless explicitly excluded or included by branches or filters.
      Parameters:
      excludeFilter - The filter matcher.
      Returns:
      A reference to this LDIFEntryReader.

    • setIncludeAttribute

      public LDIFEntryReader setIncludeAttribute(AttributeDescription attributeDescription)
      Ensures that the named attribute is not excluded from any entries that are read from 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 LDIFEntryReader.

    • setIncludeBranch

      public LDIFEntryReader setIncludeBranch(DN includeBranch)
      Ensures that all entries beneath the named entry (inclusive) are read from 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 LDIFEntryReader.

    • setIncludeFilter

      public LDIFEntryReader setIncludeFilter(Matcher includeFilter)
      Ensures that all entries which match the provided filter matcher are read from LDIF. By default all entries are read unless explicitly excluded or included by branches or filters.
      Parameters:
      includeFilter - The filter matcher.
      Returns:
      A reference to this LDIFEntryReader.

    • setRejectedLDIFListener

      public LDIFEntryReader setRejectedLDIFListener(RejectedLDIFListener listener)
      Sets the rejected record listener which should be notified whenever an LDIF record is skipped, malformed, or fails schema validation.

      By default the RejectedLDIFListener.FAIL_FAST listener is used.

      Parameters:
      listener - The rejected record listener.
      Returns:
      A reference to this LDIFEntryReader.

    • setSchema

      public LDIFEntryReader setSchema(Schema schema)
      Sets the schema which should be used for decoding entries that are read from LDIF. The default schema is used if no other is specified.
      Parameters:
      schema - The schema which should be used for decoding entries that are read from LDIF.
      Returns:
      A reference to this LDIFEntryReader.

    • setSchemaValidationPolicy

      public LDIFEntryReader setSchemaValidationPolicy(SchemaValidationPolicy policy)
      Specifies the schema validation which should be used when reading LDIF entry records. If attribute value validation is enabled then all checks will be performed.

      Schema validation is disabled by default.

      NOTE: this method copies the provided policy so changes made to it after this method has been called will have no effect.

      Parameters:
      policy - The schema validation which should be used when reading LDIF entry records.
      Returns:
      A reference to this LDIFEntryReader.