com.whitestein.lsps.engine

Interface MigrationService

All Known Subinterfaces:

MigrationServiceLocal, MigrationServiceRemote

All Known Implementing Classes:

MigrationServiceBean

public interface MigrationService

Interface for migration of model instances.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
void	abortModelUpdate(long modelInstanceId) Aborts model update process for given model instance.
List<MigrationIncompatibility>	checkModelInstanceCompatibility(long modelInstanceId, long migrationId) Returns a set of data holding information about incompatibilities in a model instance with respect to a new model.
void	continuePostUpdate(long modelInstanceId) Continues model update of the specified model instance by the post processing phase.
void	continueTransform(long modelInstanceId) Continues model update of the specified model instance by the transformation phase.
Migration	createMigration(String migrationName, ByteData migrationConfig, ByteData externalDataMappings) Uploads migration configuration to the server.
ByteData	getExternalDataMappings(long migrationId) Returns the migration external data mapping by the migration id.
Migration	getMigration(long migrationId) Returns a migration by its id.
ByteData	getMigrationConfig(long migrationId) Returns the migration configuration by the migration id.
List<ModelUpdate>	getMigrationItems(long migrationId) Returns a list of all model instance migrations that belong to the specified migration.
List<Migration>	getMigrations() Returns a list of all migrations.
String	getModelInstanceMigrationLog(long modelInstanceMigrationId) Returns a model instance log for the given model instance migration id.
List<ModelUpdate>	getModelInstanceMigrations(long modelInstanceId) Returns a list of model instance migrations ordered by the migration date.
void	updateModel(long modelInstanceId, long migrationId) Changes the model for a running model instance.

Method Detail

createMigration

Migration createMigration(String migrationName,
                          ByteData migrationConfig,
                          ByteData externalDataMappings)

Uploads migration configuration to the server.

Parameters:

migrationName -

migrationConfig -

externalDataMappings -

Returns:

id of the uploaded migration configuration

updateModel

void updateModel(long modelInstanceId,
                 long migrationId)
          throws ModelInstanceNotFoundException,
                 InvalidModelInstanceStateException,
                 MigrationNotFoundException,
                 ErrorException

Changes the model for a running model instance.

Parameters:

modelInstanceId -

migrationId -

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

MigrationNotFoundException

ErrorException

continueTransform

void continueTransform(long modelInstanceId)
                throws ModelInstanceNotFoundException,
                       InvalidModelInstanceStateException,
                       ErrorException

Continues model update of the specified model instance by the transformation phase.

Parameters:

modelInstanceId -

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

ErrorException

continuePostUpdate

void continuePostUpdate(long modelInstanceId)
                 throws ModelInstanceNotFoundException,
                        InvalidModelInstanceStateException,
                        ErrorException

Continues model update of the specified model instance by the post processing phase.

Parameters:

modelInstanceId -

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

ErrorException

abortModelUpdate

void abortModelUpdate(long modelInstanceId)
               throws ModelInstanceNotFoundException,
                      InvalidModelInstanceStateException,
                      ErrorException

Aborts model update process for given model instance.

Parameters:

modelInstanceId -

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

ErrorException

getMigration

Migration getMigration(long migrationId)

Returns a migration by its id.

Parameters:

migrationId -

Returns:

a migration by its id

getMigrations

List<Migration> getMigrations()

Returns a list of all migrations.

Returns:

a list of all migrations

getMigrationItems

List<ModelUpdate> getMigrationItems(long migrationId)
                             throws MigrationNotFoundException

Returns a list of all model instance migrations that belong to the specified migration.

Parameters:

migrationId -

Returns:

a list of all model instance migrations that belong to the specified migration

Throws:

MigrationNotFoundException

getModelInstanceMigrations

List<ModelUpdate> getModelInstanceMigrations(long modelInstanceId)
                                      throws ModelInstanceNotFoundException

Returns a list of model instance migrations ordered by the migration date.

Parameters:

modelInstanceId -

Returns:

a list of model instance migrations

Throws:

ModelInstanceNotFoundException

getModelInstanceMigrationLog

String getModelInstanceMigrationLog(long modelInstanceMigrationId)
                             throws ModelInstanceMigrationNotFoundException

Returns a model instance log for the given model instance migration id.

Parameters:

modelInstanceMigrationId -

Returns:

a model instance log for the given model instance migration id

Throws:

ModelInstanceMigrationNotFoundException

getMigrationConfig

ByteData getMigrationConfig(long migrationId)
                     throws MigrationNotFoundException

Returns the migration configuration by the migration id.

Parameters:

migrationId -

Returns:

the migration configuration by the migration id

Throws:

MigrationNotFoundException

getExternalDataMappings

ByteData getExternalDataMappings(long migrationId)
                          throws MigrationNotFoundException

Returns the migration external data mapping by the migration id.

Parameters:

migrationId -

Returns:

the migration external data mapping by the migration id

Throws:

MigrationNotFoundException

checkModelInstanceCompatibility

List<MigrationIncompatibility> checkModelInstanceCompatibility(long modelInstanceId,
                                                               long migrationId)
                                                        throws ModelInstanceNotFoundException,
                                                               MigrationNotFoundException

Returns a set of data holding information about incompatibilities in a model instance with respect to a new model.

Parameters:

modelInstanceId -

migrationId -

Returns:

set of data holding information about incompatibilities in a model instance with respect to a new model

Throws:

ModelInstanceNotFoundException

MigrationNotFoundException