Package com.inductiveautomation.ignition.gateway.authentication.resources

Class InternalUsersMigrationAugmenter

java.lang.Object

com.inductiveautomation.ignition.gateway.authentication.resources.InternalUsersMigrationAugmenter

All Implemented Interfaces:

ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

public class InternalUsersMigrationAugmenter
extends Object
implements ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

This ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter helps migrate internal users from the internal user tables to a users.json file that will be stored in the Internal and AD/Internal user source profile resources - alongside the resource.json and config.json files.

Constructor Summary

Constructors

Constructor	Description
InternalUsersMigrationAugmenter()

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InternalUsersMigrationAugmenter

public InternalUsersMigrationAugmenter()

Method Details

augment

public void augment(MigrationContext context,
 PersistentRecord profileRecord,
 @Nullable
 PersistentRecord settingsRecord,
 ResourceBuilder resourceBuilder)

Description copied from interface: ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

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.

Specified by:

augment in interface ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

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

public List<org.apache.commons.lang3.tuple.Pair<SRecordMeta<? extends SRecordInstance>,SFieldBoolean>> getMetaMigrationPairs()

Description copied from interface: ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

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.

Specified by:

getMetaMigrationPairs in interface ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

Returns:

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