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

Class SingletonRecordMigrationStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.SingletonRecordMigrationStrategy

All Implemented Interfaces:

IdbMigrationStrategy

public class SingletonRecordMigrationStrategy
extends Object
implements IdbMigrationStrategy

A migration strategy for a singleton record which will become singleton resources. Expects the singleton record to be stored with a LongField ID = 0L

Nested Class Summary

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 SFieldBoolean	enabledField

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

MIGRATION_ACTOR

Constructor Summary

Constructors

Constructor	Description
SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, ResourceType resourceType)
SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, ResourceType resourceType, RecordEncodingDelegate encodingDelegate)
SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, ResourceType resourceType, ResourceTypeMeta<?> resourceTypeMeta, RecordEncodingDelegate encodingDelegate)	Use this constructor if the resource being migrated needs to be in a location other than ConfigurationManager.CORE, for example ConfigurationManager.LOCAL
SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, SFieldLong idField, ResourceType resourceType, RecordEncodingDelegate encodingDelegate)
SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, SFieldLong idField, SFieldBoolean enabledField, ResourceType resourceType, RecordEncodingDelegate encodingDelegate, ResourceTypeMeta<?> resourceTypeMeta)

Method Summary

Modifier and Type	Method	Description
protected void	encodeResource(RecordEncodingContext context, ResourceBuilder builder)
protected static void	encodeResource(RecordEncodingContext context, ResourceBuilder builder, RecordEncodingDelegate encodingDelegate)
protected String	getCollectionName()
List<SRecordMeta<? extends SRecordInstance>>	getRecordMetas()
protected boolean	isEnabled(PersistentRecord persistentRecord)
IdbMigrationStrategy.MigrationResult	migrate(MigrationContext context)	Migrate records from the internal database to the configuration resource collection.
protected List<ChangeOperation>	migrate(MigrationContext context, PersistentRecord singletonRecord)
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

Field Details

enabledField

protected final SFieldBoolean enabledField

Constructor Details

SingletonRecordMigrationStrategy

public SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 ResourceType resourceType)

SingletonRecordMigrationStrategy

public SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 ResourceType resourceType,
 RecordEncodingDelegate encodingDelegate)

SingletonRecordMigrationStrategy

public SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 ResourceType resourceType,
 ResourceTypeMeta<?> resourceTypeMeta,
 RecordEncodingDelegate encodingDelegate)

Use this constructor if the resource being migrated needs to be in a location other than ConfigurationManager.CORE, for example ConfigurationManager.LOCAL

SingletonRecordMigrationStrategy

public SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 SFieldLong idField,
 ResourceType resourceType,
 RecordEncodingDelegate encodingDelegate)

SingletonRecordMigrationStrategy

public SingletonRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 SFieldLong idField,
 SFieldBoolean enabledField,
 ResourceType resourceType,
 RecordEncodingDelegate encodingDelegate,
 ResourceTypeMeta<?> resourceTypeMeta)

Method Details

isEnabled

protected boolean isEnabled(PersistentRecord persistentRecord)

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 List<ChangeOperation> migrate(MigrationContext context,
 PersistentRecord singletonRecord)

encodeResource

protected void encodeResource(RecordEncodingContext context,
 ResourceBuilder builder)

encodeResource

protected static void encodeResource(RecordEncodingContext context,
 ResourceBuilder builder,
 RecordEncodingDelegate encodingDelegate)

getCollectionName

protected String getCollectionName()

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