Annotation Type EntityMigrationSettings

@Retention(RUNTIME)
@Target(TYPE)
public @interface EntityMigrationSettings

Annotation for entity classes with additional details how to migrate instances of the entity. Migration refers to converting encrypted data from one encryption key to another.

Since:

8.3.5

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	EntityMigrationSettings.CustomAction	Used by EntityMigrationSettings, includes a reason for why the entity is ignored during migration.
static interface	EntityMigrationSettings.CustomEncryptionMigrator<T>	A custom migrator to apply to each instance of an entity to migrate.
static enum	EntityMigrationSettings.CustomMigrationAction	Custom strategy when migrating entities.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
EntityMigrationSettings.CustomAction	customAction	Define a custom strategy for migrating entities.
Class<? extends EntityMigrationSettings.CustomEncryptionMigrator<?>>[]	migrators	List of custom migrators to apply to each instance of the entity.
int	pageSize	The number of entities to migrate in one batch.

Element Details

customAction

EntityMigrationSettings.CustomAction customAction

Define a custom strategy for migrating entities. By default, entities are migrated using the default strategy.

Returns:

Whether to ignore the entity during migration.

Default:

@de.xima.fc.annotations.EntityMigrationSettings.CustomAction(action=DEFAULT, reason="Not ignored")

migrators

Class<? extends EntityMigrationSettings.CustomEncryptionMigrator<?>>[] migrators

List of custom migrators to apply to each instance of the entity. Can be used to perform custom business logic.

Returns:

The list of custom migrators to apply to each instance of the entity.

Default:

{}

pageSize

int pageSize

The number of entities to migrate in one batch. If set to 0 (or negative), uses an implementation-specific default.

Returns:

The number of entities to migrate in one batch.

Default:

0