Package com.inductiveautomation.ignition.gateway.config.migration

Class ExtensionPointRecordMigrationStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.ExtensionPointRecordMigrationStrategy

All Implemented Interfaces:

IdbMigrationStrategy

public class ExtensionPointRecordMigrationStrategy
extends Object
implements IdbMigrationStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtensionPointRecordMigrationStrategy.Builder	Builder for ExtensionPointRecordMigrationStrategy
static interface	ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.migration.IdbMigrationStrategy

IdbMigrationStrategy.MigrationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected final SFieldString	descriptionField	The field that represents the profile description, on the profile record.
protected final SFieldBoolean	enabledField	The field that represents the enabled state of the profile record.
protected final org.slf4j.Logger	log
protected final SFieldString	nameField	The field that represents the profile name, on the profile record.
protected final RecordMeta<? extends PersistentRecord>	profileMeta	The record meta for the profile record - the "parent" settings record for the extension point
protected final RecordEncodingDelegate	profileRecordEncoder
protected final ResourceType	resourceType	The resource type for the extension point to be migrated to
protected final RecordEncodingDelegate	settingsRecordEncoder

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.migration.IdbMigrationStrategy

MIGRATION_ACTOR

Constructor Summary

Constructors

Constructor

Description

ExtensionPointRecordMigrationStrategy(String typeId, RecordMeta<? extends PersistentRecord> profileMeta, RecordMeta<? extends PersistentRecord> settingsMeta, SFieldString nameField, SFieldString descriptionField, SFieldBoolean enabledField, SFieldBoolean migratedField, SFieldString typeField, SFieldReference<?> settingsRecordForeignKey, ResourceType resourceType, RecordEncodingDelegate profileRecordEncoder, RecordEncodingDelegate settingsRecordEncoder, Predicate<PersistentRecord> profilePredicate, ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter resourceMigrationAugmenter)

Method Summary

Modifier and Type	Method	Description
protected void	encodeResource(RecordEncodingContext profileRecordContext, RecordEncodingContext settingsRecordContext, ResourceBuilder builder)
protected String	getCollectionName()	By default, resources will be added to ConfigurationManager.CORE, override this as necessary to change the default behavior.
protected String	getName(PersistentRecord persistentRecord)
List<SRecordMeta<? extends SRecordInstance>>	getRecordMetas()
@NotNull String	getStrategyName()	A human-readable name for this migration strategy to use in the migration log.
protected boolean	isEnabled(PersistentRecord persistentRecord)
IdbMigrationStrategy.MigrationResult	migrate(MigrationContext context)	Migrate records from the internal database to the configuration resource collection.
protected Optional<ChangeOperation>	migrate(MigrationContext context, PersistentRecord profileRecord, PersistentRecord settingsRecord)
static ExtensionPointRecordMigrationStrategy.Builder	newBuilder(String typeId)	Create a new ExtensionPointRecordMigrationStrategy.Builder for an ExtensionPointRecordMigrationStrategy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.migration.IdbMigrationStrategy

getTableNames

Field Details

log

protected final org.slf4j.Logger log

profileMeta

protected final RecordMeta<? extends PersistentRecord> profileMeta

The record meta for the profile record - the "parent" settings record for the extension point

resourceType

protected final ResourceType resourceType

The resource type for the extension point to be migrated to

nameField

protected final SFieldString nameField

The field that represents the profile name, on the profile record.

descriptionField

protected final SFieldString descriptionField

The field that represents the profile description, on the profile record. Will be used for the resource's documentation field.

enabledField

@Nullable
protected final SFieldBoolean enabledField

The field that represents the enabled state of the profile record.

profileRecordEncoder

protected final RecordEncodingDelegate profileRecordEncoder

settingsRecordEncoder

protected final RecordEncodingDelegate settingsRecordEncoder

Constructor Details

ExtensionPointRecordMigrationStrategy

public ExtensionPointRecordMigrationStrategy(String typeId,
 RecordMeta<? extends PersistentRecord> profileMeta,
 @Nullable
 RecordMeta<? extends PersistentRecord> settingsMeta,
 SFieldString nameField,
 @Nullable
 SFieldString descriptionField,
 @Nullable
 SFieldBoolean enabledField,
 SFieldBoolean migratedField,
 SFieldString typeField,
 @Nullable
 SFieldReference<?> settingsRecordForeignKey,
 ResourceType resourceType,
 RecordEncodingDelegate profileRecordEncoder,
 @Nullable
 RecordEncodingDelegate settingsRecordEncoder,
 Predicate<PersistentRecord> profilePredicate,
 @Nullable
 ExtensionPointRecordMigrationStrategy.ResourceMigrationAugmenter resourceMigrationAugmenter)

Method Details

migrate

public IdbMigrationStrategy.MigrationResult migrate(MigrationContext context)
                                             throws MigrationException

Description copied from interface: IdbMigrationStrategy

Migrate records from the internal database to the configuration resource collection. To do this, use the given session to issue an SQuery to find the records you want to migrate. Then compile a list of ChangeOperation that will be applied to the config resource collection to add the appropriate resources.

Specified by:

migrate in interface IdbMigrationStrategy

Parameters:

context - a MigrationContext which provides methods for accessing a PersistenceSession to query the internal DB as well as a ConfigurationManager for accessing the new config resource APIs

Returns:

A list of change operations that will be applied to the config resource collection.

Throws:

MigrationException - If an error occurs during migration.

migrate

protected Optional<ChangeOperation> migrate(MigrationContext context,
 PersistentRecord profileRecord,
 @Nullable
 PersistentRecord settingsRecord)

encodeResource

protected void encodeResource(RecordEncodingContext profileRecordContext,
 @Nullable
 RecordEncodingContext settingsRecordContext,
 ResourceBuilder builder)

getName

protected String getName(PersistentRecord persistentRecord)

isEnabled

protected boolean isEnabled(PersistentRecord persistentRecord)

getCollectionName

protected String getCollectionName()

By default, resources will be added to ConfigurationManager.CORE, override this as necessary to change the default behavior.

getRecordMetas

public List<SRecordMeta<? extends SRecordInstance>> getRecordMetas()

Specified by:

getRecordMetas in interface IdbMigrationStrategy

Returns:

The record metas that this strategy migrates, if any. If this strategy does not migrate records, return an empty list. Also note that any record metas returned here will automatically be applied to the SchemaUpdater.updatePersistentRecords(Iterable), so you do not need to do this again in your GatewayModuleHook setup() method.

newBuilder

public static ExtensionPointRecordMigrationStrategy.Builder newBuilder(String typeId)

Create a new ExtensionPointRecordMigrationStrategy.Builder for an ExtensionPointRecordMigrationStrategy

Parameters:

typeId - The type identifier for the specific extension point type

getStrategyName

@NotNull
public @NotNull String getStrategyName()

Description copied from interface: IdbMigrationStrategy

A human-readable name for this migration strategy to use in the migration log.

Specified by:

getStrategyName in interface IdbMigrationStrategy