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

Class NamedRecordMigrationStrategy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.migration.NamedRecordMigrationStrategy

All Implemented Interfaces:

IdbMigrationStrategy

public class NamedRecordMigrationStrategy
extends Object
implements IdbMigrationStrategy

Migrates records that are identified by unique name. The ID field of the record will be discarded and the name will become the last path component of the resource path.

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 SFieldString	descriptionField
protected final SFieldBoolean	enabledField
protected final RecordEncodingDelegate	encodingDelegate
protected final org.slf4j.Logger	log
protected final RecordMeta<? extends PersistentRecord>	meta
protected final SFieldString	nameField
protected final ResourceType	resourceType

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

MIGRATION_ACTOR

Constructor Summary

Constructors

Constructor	Description
NamedRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, ResourceType resourceType)
NamedRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, ResourceType resourceType, RecordEncodingDelegate encodingDelegate)
NamedRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta, SFieldString nameField, SFieldString descriptionField, SFieldBoolean enabledField, ResourceType resourceType, RecordEncodingDelegate encodingDelegate)

Method Summary

Modifier and Type	Method	Description
protected void	encodeResource(RecordEncodingContext context, 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()
protected boolean	isEnabled(PersistentRecord persistentRecord)
IdbMigrationStrategy.MigrationResult	migrate(MigrationContext context)	Migrate records from the internal database to the configuration resource collection.
protected Optional<ChangeOperation>	migrateRecord(MigrationContext context, String name, PersistentRecord persistentRecord)
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

log

protected final org.slf4j.Logger log

meta

protected final RecordMeta<? extends PersistentRecord> meta

resourceType

protected final ResourceType resourceType

nameField

protected final SFieldString nameField

descriptionField

protected final SFieldString descriptionField

enabledField

protected final SFieldBoolean enabledField

encodingDelegate

protected final RecordEncodingDelegate encodingDelegate

Constructor Details

NamedRecordMigrationStrategy

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

NamedRecordMigrationStrategy

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

NamedRecordMigrationStrategy

public NamedRecordMigrationStrategy(RecordMeta<? extends PersistentRecord> meta,
 SFieldString nameField,
 @Nullable
 SFieldString descriptionField,
 @Nullable
 SFieldBoolean enabledField,
 ResourceType resourceType,
 RecordEncodingDelegate encodingDelegate)

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.

migrateRecord

protected Optional<ChangeOperation> migrateRecord(MigrationContext context,
 String name,
 PersistentRecord persistentRecord)

getName

protected String getName(PersistentRecord persistentRecord)

isEnabled

protected boolean isEnabled(PersistentRecord persistentRecord)

encodeResource

protected void encodeResource(RecordEncodingContext context,
 ResourceBuilder builder)

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.

toString

public String toString()

Overrides:

toString in class Object