Package com.unboundid.ldap.sdk.transformations

Class RedactAttributeTransformation

java.lang.Object
com.unboundid.ldap.sdk.transformations.RedactAttributeTransformation
All Implemented Interfaces:
EntryTransformation, LDIFChangeRecordTransformation, LDIFReaderChangeRecordTranslator, LDIFReaderEntryTranslator, LDIFWriterChangeRecordTranslator, LDIFWriterEntryTranslator
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RedactAttributeTransformation extends Object implements EntryTransformation, LDIFChangeRecordTransformation
This class provides an implementation of an entry and LDIF change record transformation that will redact the values of a specified set of attributes so that it will be possible to determine whether the attribute had been present in an entry or change record, but not what the values were for that attribute.

  • Constructor Details

    • RedactAttributeTransformation

      public RedactAttributeTransformation(@Nullable Schema schema, boolean redactDNAttributes, boolean preserveValueCount, @NotNull String... attributes)
      Creates a new redact attribute transformation that will redact the values of the specified attributes.
      Parameters:
      schema - The schema to use to identify alternate names that may be used to reference the attributes to redact. It may be null to use a default standard schema.
      redactDNAttributes - Indicates whether to redact values of the target attributes that appear in DNs. This includes the DNs of the entries to process as well as the values of attributes with a DN syntax.
      preserveValueCount - Indicates whether to preserve the number of values in redacted attributes. If this is true, then multivalued attributes that are redacted will have the same number of values but each value will be replaced with "***REDACTED{num}***" where "{num}" is a counter that increments for each value. If this is false, then the set of values will always be replaced with a single value of "***REDACTED***" regardless of whether the original attribute had one or multiple values.
      attributes - The names of the attributes whose values should be redacted. It must must not be null or empty.

    • RedactAttributeTransformation

      public RedactAttributeTransformation(@Nullable Schema schema, boolean redactDNAttributes, boolean preserveValueCount, @NotNull Collection<String> attributes)
      Creates a new redact attribute transformation that will redact the values of the specified attributes.
      Parameters:
      schema - The schema to use to identify alternate names that may be used to reference the attributes to redact. It may be null to use a default standard schema.
      redactDNAttributes - Indicates whether to redact values of the target attributes that appear in DNs. This includes the DNs of the entries to process as well as the values of attributes with a DN syntax.
      preserveValueCount - Indicates whether to preserve the number of values in redacted attributes. If this is true, then multivalued attributes that are redacted will have the same number of values but each value will be replaced with "***REDACTED{num}***" where "{num}" is a counter that increments for each value. If this is false, then the set of values will always be replaced with a single value of "***REDACTED***" regardless of whether the original attribute had one or multiple values.
      attributes - The names of the attributes whose values should be redacted. It must must not be null or empty.

  • Method Details

    • transformEntry

      @Nullable public Entry transformEntry(@NotNull Entry e)
      Applies an appropriate transformation to the provided entry.
      Specified by:
      transformEntry in interface EntryTransformation
      Parameters:
      e - The entry to transform.
      Returns:
      A copy of the entry with any appropriate transformation applied, the original entry if no transformations were necessary, or null if the entry should be suppressed.

    • transformChangeRecord

      @Nullable public LDIFChangeRecord transformChangeRecord(@NotNull LDIFChangeRecord r)
      Applies an appropriate transformation to the provided LDIF change record.
      Specified by:
      transformChangeRecord in interface LDIFChangeRecordTransformation
      Parameters:
      r - The LDIF change record to transform.
      Returns:
      A copy of the change record with any appropriate transformation applied, the original change record if no transformations were necessary, or null if the change record should be suppressed.

    • translate

      @Nullable public Entry translate(@NotNull Entry original, long firstLineNumber)
      Applies some special transformation or filtering to the original Entry.
      Specified by:
      translate in interface LDIFReaderEntryTranslator
      Parameters:
      original - The original Entry that was read and parsed from the input file.
      firstLineNumber - The first line number of the LDIF record corresponding to the read Entry. This is most useful when throwing an LDIFException.
      Returns:
      The Entry that should be returned in the call to LDIFReader.readEntry(). This can be the original parameter Entry, a newly constructed Entry, or null to signal that the provided Entry should be skipped.

    • translate

      @Nullable public LDIFChangeRecord translate(@NotNull LDIFChangeRecord original, long firstLineNumber)
      Applies some special transformation or filtering to the original change record.
      Specified by:
      translate in interface LDIFReaderChangeRecordTranslator
      Parameters:
      original - The original change record that was read and parsed from the input file.
      firstLineNumber - The first line number of the LDIF change record. This is most useful when throwing an LDIFException.
      Returns:
      The LDIF change record that should be returned in the call to LDIFReader.readChangeRecord(). This can be the original parameter change record, a newly constructed change record, or null to signal that the provided change record should be skipped.

    • translateEntryToWrite

      @Nullable public Entry translateEntryToWrite(@NotNull Entry original)
      Applies some special transformation or filtering to the original Entry.
      Specified by:
      translateEntryToWrite in interface LDIFWriterEntryTranslator
      Parameters:
      original - The original Entry that was to be written.
      Returns:
      The Entry that should be written. This can be the original parameter Entry, a newly-constructed Entry, or null to signal that this Entry should not be written. Note, however, that if the original entry provided as a parameter is altered, then the change will be visible to anything that references that entry. If you are not sure about whether changes to the original entry are acceptable, it is recommended that you use the duplicate() method to create a copy of the original and make the necessary changes to that duplicate.

    • translateChangeRecordToWrite

      @Nullable public LDIFChangeRecord translateChangeRecordToWrite(@NotNull LDIFChangeRecord original)
      Applies some special transformation or filtering to the original change record.
      Specified by:
      translateChangeRecordToWrite in interface LDIFWriterChangeRecordTranslator
      Parameters:
      original - The original change record that was to be written.
      Returns:
      The change record that should be written. This can be the original parameter change record, a newly-constructed change record, or null to signal that the change record should not be written. Note, however, that if the original record provided as a parameter is altered, then the change will be visible to anything that references that change record. If you are not sure about whether changes to the original change record are acceptable, it is recommended that you use the duplicate() method to create a copy of the original and make the necessary changes to that duplicate.