com.day.cq.compat.codeupgrade

Interface CodeUpgradeTask

All Superinterfaces:

java.lang.Runnable

@ConsumerType
public interface CodeUpgradeTask
extends java.lang.Runnable

A service that executes a code upgrade. From CQ5.6 on, such services are executed by the cq-upgrades-executor bundle Activator, synchronously when that bundle starts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CodeUpgradeTask.MigrationType Declares if the CodeUpgradeTask needs to be executed immediately with upgrade startup or may be delayed

Method Summary

Modifier and Type	Method and Description
void	cancelUpgrade() Called to cancel an upgrade that might be in progress
java.lang.String	getProgressInfo()
boolean	upgradeNeeded()

Methods inherited from interface java.lang.Runnable

run

Method Detail

upgradeNeeded

boolean upgradeNeeded()

Returns:

True if an upgrade is needed

cancelUpgrade

void cancelUpgrade()

Called to cancel an upgrade that might be in progress

getProgressInfo

java.lang.String getProgressInfo()

Returns:

upgrade progress info string currently set