Package org.nuxeo.runtime.migration

Class MigrationService.MigrationStatus

java.lang.Object

org.nuxeo.runtime.migration.MigrationService.MigrationStatus

Enclosing interface:

MigrationService

public static class MigrationService.MigrationStatus
extends Object

The status of a migration.

A migration is either running or not. When not running, it just has a state.

When running, it has a step, start time, and progress information (message, num, total, last ping time).

Since:

9.3

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	errorCode
protected final String	errorMessage
protected final long	pingTime
protected final String	progressMessage
protected final long	progressNum
protected final long	progressTotal
protected final long	startTime
protected final String	state
protected final String	step

Constructor Summary

Constructors

Constructor	Description
MigrationStatus(String state)
MigrationStatus(String step, long startTime, long pingTime, String progressMessage, long progressNum, long progressTotal)
MigrationStatus(String step, long startTime, long pingTime, String progressMessage, long progressNum, long progressTotal, String errorMessage, int errorCode)
MigrationStatus(String state, String errorMessage, int errorCode)

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Gets the error code if any.
String	getErrorMessage()	Gets the error message if any.
long	getPingTime()	Gets the ping time of the migration, if it's running.
String	getProgressMessage()	Gets the progress message of the migration, if it's running.
long	getProgressNum()	Gets the progress "num" of the migration, if it's running.
long	getProgressTotal()	Gets the progress "total" of the migration, if it's running.
long	getStartTime()	Gets the start time of the migration, if it's running.
String	getState()	Gets the state of the migration, if it's not running.
String	getStep()	Gets the step of the migration, if it's running.
boolean	hasError()	Is there any error ?
boolean	isRunning()	Checks whether the migration is running.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

state

protected final String state

step

protected final String step

startTime

protected final long startTime

pingTime

protected final long pingTime

progressMessage

protected final String progressMessage

progressNum

protected final long progressNum

progressTotal

protected final long progressTotal

errorMessage

protected final String errorMessage

Since:

2023.3

errorCode

protected final int errorCode

Since:

2023.3

Constructor Details

MigrationStatus

public MigrationStatus(String state)

MigrationStatus

public MigrationStatus(String state,
 String errorMessage,
 int errorCode)

MigrationStatus

public MigrationStatus(String step,
 long startTime,
 long pingTime,
 String progressMessage,
 long progressNum,
 long progressTotal)

MigrationStatus

public MigrationStatus(String step,
 long startTime,
 long pingTime,
 String progressMessage,
 long progressNum,
 long progressTotal,
 String errorMessage,
 int errorCode)

Method Details

toString

public String toString()

Overrides:

toString in class Object

isRunning

public boolean isRunning()

Checks whether the migration is running.

Returns:

true if a migration is running, or false otherwise

getState

public String getState()

Gets the state of the migration, if it's not running.

getStep

public String getStep()

Gets the step of the migration, if it's running.

getStartTime

public long getStartTime()

Gets the start time of the migration, if it's running.

getPingTime

public long getPingTime()

Gets the ping time of the migration, if it's running.

getProgressMessage

public String getProgressMessage()

Gets the progress message of the migration, if it's running.

getProgressNum

public long getProgressNum()

Gets the progress "num" of the migration, if it's running.

getProgressTotal

public long getProgressTotal()

Gets the progress "total" of the migration, if it's running.

getErrorMessage

public String getErrorMessage()

Gets the error message if any.

Since:

2023.3

getErrorCode

public int getErrorCode()

Gets the error code if any.

Since:

2023.3

hasError

public boolean hasError()

Is there any error ?

Since:

2023.3