ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

All Known Implementing Classes:: InternalUsersMigrationAugmenter

Enclosing class:: ExtensionPointRecordMigrationStrategy

public static interface ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

Method Summary

Modifier and Type

Method

Description

void

augment(MigrationContext context, PersistentRecord profileRecord, PersistentRecord settingsRecord, ResourceBuilder resourceBuilder)

Augment the resource with additional data during ExtensionPointRecordMigrationStrategy.migrate(MigrationContext, PersistentRecord, PersistentRecord).

default List<org.apache.commons.lang3.tuple.Pair<SRecordMeta<? extends SRecordInstance>,SFieldBoolean>>

getMetaMigrationPairs()

Get the pairs of metas and migrated fields that this augmenter potentially migrates.

Method Details
- augment
  
  void augment(MigrationContext context, PersistentRecord profileRecord, @Nullable PersistentRecord settingsRecord, ResourceBuilder resourceBuilder)
  
  Augment the resource with additional data during ExtensionPointRecordMigrationStrategy.migrate(MigrationContext, PersistentRecord, PersistentRecord).
  This is called after the migrated resource has been encoded, but before it is turned into a ChangeOperation.
  
  Parameters:
  
  context - the MigrationContext.
  
  profileRecord - the profile record that was just migrated.
  
  settingsRecord - the settings record that was just migrated, or null if there is no settings record.
  
  resourceBuilder - the ResourceBuilder building the Resource.
- getMetaMigrationPairs
  
  default List<org.apache.commons.lang3.tuple.Pair<SRecordMeta<? extends SRecordInstance>,SFieldBoolean>> getMetaMigrationPairs()
  
  Get the pairs of metas and migrated fields that this augmenter potentially migrates. Each pair is a meta that is being (potentially only partially) migrated by this augmenter, and the field that represents the migration state for each entry in that table.
  If this augmenter doesn't care to keep track of what is being migrated (i.e. it doesn't migrate any fields from a record or table) then it should return an empty list.
  
  Returns:
  
  the pairs of metas and migrated fields that this augmenter migrates.