Package org.nuxeo.runtime.migration
Interface MigrationService.MigrationContext
- All Known Implementing Classes:
MigrationServiceImpl.MigrationContextImpl
- Enclosing interface:
- MigrationService
public static interface MigrationService.MigrationContext
Interface for a migration context, passed to the
MigrationService.Migrator
.- Since:
- 9.3
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if shutdown has been requested.void
reportError
(String message, int code) Notifies the migration context of an error.void
reportProgress
(String message, long num, long total) Notifies the migration context of the current progress.void
Requests a shutdown.
-
Method Details
-
reportProgress
Notifies the migration context of the current progress.- Parameters:
message
- an informative message about what is being migratednum
- the current number of things migratedtotal
- the total number of things to migrate, or-1
if unknown
-
reportError
Notifies the migration context of an error.- Parameters:
message
- an informative message about what went wrongcode
- the error code
-
requestShutdown
void requestShutdown()Requests a shutdown. Called internally by the migration service when the server shuts down. -
isShutdownRequested
boolean isShutdownRequested()Checks if shutdown has been requested.This should be checked periodically by the migrator, and when
true
the migrator should return as soon as possible, even if its work is not complete.This is a "nice" version of thread interruption, which will follow a short while later, and should also be checked by the migrator.
- Returns:
true
if migration should be stopped as soon as possible
-