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

Class NoOpMigrationStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.NoOpMigrationStrategy

All Implemented Interfaces:

IdbMigrationStrategy

public class NoOpMigrationStrategy
extends Object
implements IdbMigrationStrategy

A no-operation implementation of IdbMigrationStrategy.

This strategy does not perform any migration logic. It is typically used for tables that do not require migration or for placeholder purposes.

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
NoOpMigrationStrategy(List<SRecordMeta<? extends SRecordInstance>> recordMetas)	Constructs a NoOpMigrationStrategy instance for the provided list of record metadata.
NoOpMigrationStrategy(SRecordMeta<? extends SRecordInstance> recordMeta)	Constructs a NoOpMigrationStrategy instance for a single record metadata.

Method Summary

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

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

Constructor Details

NoOpMigrationStrategy

public NoOpMigrationStrategy(SRecordMeta<? extends SRecordInstance> recordMeta)

Constructs a NoOpMigrationStrategy instance for a single record metadata.

Parameters:

recordMeta - an SRecordMeta instance representing the table that will be marked as migrated. Must not be null.

Throws:

NullPointerException - if recordMeta is null.

NoOpMigrationStrategy

public NoOpMigrationStrategy(List<SRecordMeta<? extends SRecordInstance>> recordMetas)

Constructs a NoOpMigrationStrategy instance for the provided list of record metadata. This strategy does not perform any actual database migration and is typically used for marking tables as migrated without any operational changes.

Parameters:

recordMetas - a list of SRecordMeta instances representing the tables to be considered as migrated. The list must not be null and must not contain null elements.

Throws:

NullPointerException - if the recordMetas argument or any of its elements are null.

Method Details

migrate

public IdbMigrationStrategy.MigrationResult migrate(MigrationContext ignored)

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:

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

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.