Package com.atlassian.confluence.upgrade.impl

Class DefaultUpgradeGate

java.lang.Object

com.atlassian.confluence.upgrade.impl.DefaultUpgradeGate

All Implemented Interfaces:

UpgradeGate

public class DefaultUpgradeGate
extends Object
implements UpgradeGate

Method Summary

Modifier and Type	Method	Description
boolean	isPluginDependentUpgradeCompleteWithWait()	Check is the plugin dependent upgrades have been completed.
boolean	isUpgradeRequiredWithWait()	Check the upgrade status set via UpgradeGate.setUpgradeRequired(boolean).
void	setPluginDependentUpgradeComplete(boolean complete)
void	setUpgradeRequired(boolean required)

Methods inherited from class java.lang.Object

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

Method Detail

setUpgradeRequired

public void setUpgradeRequired(boolean required)

Specified by:

setUpgradeRequired in interface UpgradeGate

Parameters:

required - if true then an upgrade is required.

setPluginDependentUpgradeComplete

public void setPluginDependentUpgradeComplete(boolean complete)

Specified by:

setPluginDependentUpgradeComplete in interface UpgradeGate

Parameters:

complete - if true then the plugin dependent upgrade is finished, otherwise it is not yet complete.

isUpgradeRequiredWithWait

public boolean isUpgradeRequiredWithWait()

Description copied from interface: UpgradeGate

Check the upgrade status set via UpgradeGate.setUpgradeRequired(boolean). If it has not been set yet then the caller will keep trying for #UPGRADE_REQUIRED_CHECK_ATTEMPTS * #UPGRADE_REQUIRED_CHECK_SLEEP milliseconds before returning a default value of false.

Specified by:

isUpgradeRequiredWithWait in interface UpgradeGate

Returns:

true if an upgrade is required; false if timeout or it is not required.

isPluginDependentUpgradeCompleteWithWait

public boolean isPluginDependentUpgradeCompleteWithWait()

Description copied from interface: UpgradeGate

Check is the plugin dependent upgrades have been completed. If this is not yet true (indicating another node is performing the upgrades) then the caller will keep trying for #WAIT_FOR_OTHER_NODE_UPGRADE_ATTEMPTS * #WAIT_FOR_OTHER_NODE_UPGRADE_SLEEP milliseconds before returning a default value of false.

Specified by:

isPluginDependentUpgradeCompleteWithWait in interface UpgradeGate

Returns:

true if the plugin dependent upgrades are complete; false if the waiting times out.