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

Class ExtensionPointCleanupStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.ExtensionPointCleanupStrategy

All Implemented Interfaces:

IdbMigrationStrategy

public class ExtensionPointCleanupStrategy
extends Object
implements IdbMigrationStrategy

This strategy is registered for an extension point type, for the purpose of marking the profile table as migrated when there are no extension point instances to migrate.

Nested Class Summary

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

IdbMigrationStrategy.MigrationResult

Field Summary

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

MIGRATION_ACTOR

Constructor Summary

Constructors

Constructor	Description
ExtensionPointCleanupStrategy(SRecordMeta<? extends PersistentRecord> profileMeta)
ExtensionPointCleanupStrategy(SRecordMeta<? extends PersistentRecord> profileMeta, SFieldBoolean migratedField)

Method Summary

Modifier and Type	Method	Description
List<SRecordMeta<? extends SRecordInstance>>	getRecordMetas()
IdbMigrationStrategy.MigrationResult	migrate(MigrationContext context)	Migrate records from the internal database to the configuration resource collection.
String	toString()

Methods inherited from class java.lang.Object

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

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

getTableNames

Constructor Details

ExtensionPointCleanupStrategy

public ExtensionPointCleanupStrategy(SRecordMeta<? extends PersistentRecord> profileMeta)

ExtensionPointCleanupStrategy

public ExtensionPointCleanupStrategy(SRecordMeta<? extends PersistentRecord> profileMeta,
 SFieldBoolean migratedField)

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.

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.

toString

public String toString()

Overrides:

toString in class Object