MigrationServiceImpl (Nuxeo ECM Projects 9.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.runtime.model.DefaultComponent
- - org.nuxeo.runtime.migration.MigrationServiceImpl

All Implemented Interfaces:: MigrationService, Adaptable, Component, Extensible, TimestampedService

public class MigrationServiceImpl
extends DefaultComponent
implements MigrationService

Implementation for the Migration Service.

Data about migration status is stored in the "migration" Key/Value Store in the following format:

 mymigration:lock         write lock, containing debug info about locker; set with a TTL
 mymigration              the state of the migration, if not running
 mymigration:step         the step of the migration, if running
 mymigration:starttime    the migration step start time (milliseconds since epoch)
 mymigration:pingtime     the migration step last ping time (milliseconds since epoch)
 mymigration:message      the migration step current message
 mymigration:num          the migration step current num
 mymigration:total        the migration step current total

Since:: 9.3

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MigrationServiceImpl.MigrationContextImpl` Migration context implementation that reports progress in the key/value store and can be shutdown.
`static class`	`MigrationServiceImpl.MigrationInvalidation`
`class`	`MigrationServiceImpl.MigrationInvalidator`
`static class`	`MigrationServiceImpl.MigrationRegistry`
`protected static class`	`MigrationServiceImpl.MigrationThreadPoolExecutor` Thread pool executor that records `Runnable`s to be able to request shutdown on them.
`protected static class`	`MigrationServiceImpl.MigratorWithContext` Runnable for the migrator, that knows about the migration context.
`protected static class`	`MigrationServiceImpl.ProgressReporter` Progress reporter that reports progress in the key/value store.

Nested classes/interfaces inherited from interface org.nuxeo.runtime.migration.MigrationService
MigrationService.MigrationContext, MigrationService.MigrationStatus, MigrationService.Migrator, MigrationService.StatusChangeNotifier

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLUSTERING_ENABLED_PROP`
`static String`	`CONFIG_XP`
`protected MigrationServiceImpl.MigrationThreadPoolExecutor`	`executor`
`protected MigrationServiceImpl.MigrationInvalidator`	`invalidator`
`static String`	`KEYVALUE_STORE_NAME`
`static String`	`LOCK`
`static String`	`MIGRATION_INVAL_PUBSUB_TOPIC`
`static String`	`NODE_ID_PROP`
`static String`	`PING_TIME`
`static String`	`PROGRESS_MESSAGE`
`static String`	`PROGRESS_NUM`
`static String`	`PROGRESS_TOTAL`
`protected static Random`	`RANDOM`
`protected MigrationServiceImpl.MigrationRegistry`	`registry`
`static String`	`START_TIME`
`static String`	`STEP`
`static long`	`WRITE_LOCK_TTL`

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent
lastModified

Constructor Summary

Constructors
Constructor and Description

MigrationServiceImpl()

Constructors
Constructor and Description
`MigrationServiceImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`atomic(String id, Consumer<KeyValueStore> consumer)` Executes something while setting a lock, retrying a few times if the lock is already set.
`int`	`getApplicationStartedOrder()` The component notification order for `Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext)`.
`protected static KeyValueStore`	`getKeyValueStore()`
`Map<String,MigrationDescriptor>`	`getMigrationDescriptors()`
`MigrationService.MigrationStatus`	`getStatus(String id)` Gets the current status for a migration.
`protected MigrationService.StatusChangeNotifier`	`getStatusChangeNotifier(MigrationDescriptor descr)`
`protected MigrationService.StatusChangeNotifier`	`getStatusChangeNotifier(String id)`
`void`	`registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)`
`void`	`registerMigrationDescriptor(MigrationDescriptor descriptor)`
`void`	`runStep(String id, String step)` Runs a migration step for a migration.
`void`	`start(ComponentContext context)` Start the component.
`void`	`stop(ComponentContext context)` Stop the component.
`void`	`unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)`
`void`	`unregisterMigrationDescriptor(MigrationDescriptor descriptor)`

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent
activate, deactivate, getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.runtime.model.Component
applicationStarted

- Field Detail
  - KEYVALUE_STORE_NAME
```
public static final String KEYVALUE_STORE_NAME
```
    See Also:
    
    Constant Field Values
  - CONFIG_XP
```
public static final String CONFIG_XP
```
    See Also:
    
    Constant Field Values
  - LOCK
```
public static final String LOCK
```
    See Also:
    
    Constant Field Values
  - STEP
```
public static final String STEP
```
    See Also:
    
    Constant Field Values
  - START_TIME
```
public static final String START_TIME
```
    See Also:
    
    Constant Field Values
  - PING_TIME
```
public static final String PING_TIME
```
    See Also:
    
    Constant Field Values
  - PROGRESS_MESSAGE
```
public static final String PROGRESS_MESSAGE
```
    See Also:
    
    Constant Field Values
  - PROGRESS_NUM
```
public static final String PROGRESS_NUM
```
    See Also:
    
    Constant Field Values
  - PROGRESS_TOTAL
```
public static final String PROGRESS_TOTAL
```
    See Also:
    
    Constant Field Values
  - WRITE_LOCK_TTL
```
public static final long WRITE_LOCK_TTL
```
    See Also:
    
    Constant Field Values
  - MIGRATION_INVAL_PUBSUB_TOPIC
```
public static final String MIGRATION_INVAL_PUBSUB_TOPIC
```
    See Also:
    
    Constant Field Values
  - CLUSTERING_ENABLED_PROP
```
public static final String CLUSTERING_ENABLED_PROP
```
    See Also:
    
    Constant Field Values
  - NODE_ID_PROP
```
public static final String NODE_ID_PROP
```
    See Also:
    
    Constant Field Values
  - RANDOM
```
protected static final Random RANDOM
```
  - registry
```
protected final MigrationServiceImpl.MigrationRegistry registry
```
  - executor
```
protected MigrationServiceImpl.MigrationThreadPoolExecutor executor
```
  - invalidator
```
protected MigrationServiceImpl.MigrationInvalidator invalidator
```
- Constructor Detail
  - MigrationServiceImpl
```
public MigrationServiceImpl()
```
- Method Detail
  - getKeyValueStore
```
protected static KeyValueStore getKeyValueStore()
```
  - registerContribution
```
public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)
```
    Overrides:
    
    registerContribution in class DefaultComponent
  - unregisterContribution
```
public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)
```
    Overrides:
    
    unregisterContribution in class DefaultComponent
  - registerMigrationDescriptor
```
public void registerMigrationDescriptor(MigrationDescriptor descriptor)
```
  - unregisterMigrationDescriptor
```
public void unregisterMigrationDescriptor(MigrationDescriptor descriptor)
```
  - getMigrationDescriptors
```
public Map<String,MigrationDescriptor> getMigrationDescriptors()
```
  - getApplicationStartedOrder
```
public int getApplicationStartedOrder()
```
    Description copied from interface: Component
    
    The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).
    Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.
    
    Specified by:
    
    getApplicationStartedOrder in interface Component
    
    Returns:
    
    the order, 1000 by default
  - start
```
public void start(ComponentContext context)
```
    Description copied from interface: Component
    
    Start the component. This method is called after all the components were resolved and activated
    
    Specified by:
    
    start in interface Component
    
    Overrides:
    
    start in class DefaultComponent
  - stop
```
public void stop(ComponentContext context)
          throws InterruptedException
```
    Description copied from interface: Component
    
    Stop the component.
    
    Specified by:
    
    stop in interface Component
    
    Overrides:
    
    stop in class DefaultComponent
    
    Throws:
    
    InterruptedException
  - getStatus
```
public MigrationService.MigrationStatus getStatus(String id)
```
    Description copied from interface: MigrationService
    
    Gets the current status for a migration.
    
    Specified by:
    
    getStatus in interface MigrationService
    
    Parameters:
    
    id - the migration id
    
    Returns:
    
    the status, or null if the migration is unknown
  - runStep
```
public void runStep(String id,
                    String step)
```
    Description copied from interface: MigrationService
    
    Runs a migration step for a migration.
    This launches the migration asynchronously. The status of the migration can be checked with MigrationService.getStatus(java.lang.String).
    
    Specified by:
    
    runStep in interface MigrationService
    
    Parameters:
    
    id - the migration id
    
    step - the step id
  - getStatusChangeNotifier
```
protected MigrationService.StatusChangeNotifier getStatusChangeNotifier(String id)
```
  - getStatusChangeNotifier
```
protected MigrationService.StatusChangeNotifier getStatusChangeNotifier(MigrationDescriptor descr)
```
  - atomic
```
protected void atomic(String id,
                      Consumer<KeyValueStore> consumer)
```
    Executes something while setting a lock, retrying a few times if the lock is already set.

Class MigrationServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.runtime.migration.MigrationService

Field Summary

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

Constructor Summary

Method Summary

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.runtime.model.Component

Field Detail

KEYVALUE_STORE_NAME

CONFIG_XP

LOCK

STEP

START_TIME

PING_TIME

PROGRESS_MESSAGE

PROGRESS_NUM

PROGRESS_TOTAL

WRITE_LOCK_TTL

MIGRATION_INVAL_PUBSUB_TOPIC

CLUSTERING_ENABLED_PROP

NODE_ID_PROP

RANDOM

registry

executor

invalidator

Constructor Detail

MigrationServiceImpl

Method Detail

getKeyValueStore

registerContribution

unregisterContribution

registerMigrationDescriptor

unregisterMigrationDescriptor

getMigrationDescriptors

getApplicationStartedOrder

start

stop

getStatus

runStep

getStatusChangeNotifier

getStatusChangeNotifier

atomic