Class RenameAttributeTransformation

    • Constructor Detail

      • RenameAttributeTransformation

        public RenameAttributeTransformation​(@Nullable
                                             Schema schema,
                                             @NotNull
                                             java.lang.String sourceAttribute,
                                             @NotNull
                                             java.lang.String targetAttribute,
                                             boolean renameInDNs)
        Creates a new rename attribute transformation with the provided information.
        Parameters:
        schema - The schema to use in processing. If this is null, a default standard schema will be used.
        sourceAttribute - The name of the source attribute to be replaced with the name of the target attribute. It must not be null.
        targetAttribute - The name of the target attribute to use in place of the source attribute. It must not be null.
        renameInDNs - Indicates whether to rename attributes contained in DNs. This includes both in the DN of an entry to be transformed, but also in the values of attributes with a DN syntax.
    • Method Detail

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