RebuildIndexUpgradeTask (Atlassian Confluence 5.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atlassian.confluence.upgrade.upgradetask
Class RebuildIndexUpgradeTask

java.lang.Object
  com.atlassian.confluence.upgrade.AbstractUpgradeTask
      com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask
          com.atlassian.confluence.upgrade.upgradetask.RebuildIndexUpgradeTask

All Implemented Interfaces:: BackupSupport, DeferredUpgradeTask, UpgradeTask, UpgradeTaskInfo, org.springframework.beans.factory.BeanNameAware

public class RebuildIndexUpgradeTask
extends AbstractDeferredRunUpgradeTask
extends AbstractDeferredRunUpgradeTask

Trigger a rebuild of the lucene index

Constructor Summary
`RebuildIndexUpgradeTask()`

Method Summary
`boolean`	`breaksBackwardCompatibility()` Returns true if a new export can't be imported in an older instance.
`void`	`doDeferredUpgrade()` Run the upgrade that was deferred by an earlier call to doUpgrade.
`void`	`doUpgrade()` Perform the upgrade.
`java.lang.String`	`getBuildNumber()` Manually bump this to the latest build number if you want the reindex to be executed.
`java.lang.String`	`getShortDescription()` A short (<50 chars) description of the upgrade action
`boolean`	`runOnSpaceImport()` Returns true if an older Space can't be imported in a new instance without running this task.
`void`	`setTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)`

Methods inherited from class com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask
`isUpgradeRequired, setUpgradeRequired`

Methods inherited from class com.atlassian.confluence.upgrade.AbstractUpgradeTask
`addAllErrors, addError, addError, getConstraint, getErrors, getName, isDatabaseUpgrade, setBeanName, setBuildNumber, validate`

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

Methods inherited from interface com.atlassian.confluence.upgrade.UpgradeTask
`getConstraint, getErrors, validate`

Methods inherited from interface com.atlassian.confluence.upgrade.UpgradeTaskInfo
`getName, isDatabaseUpgrade`

Constructor Detail

RebuildIndexUpgradeTask

public RebuildIndexUpgradeTask()

Method Detail

setTaskManager

public void setTaskManager(com.atlassian.core.task.MultiQueueTaskManager taskManager)

doDeferredUpgrade

public void doDeferredUpgrade()
                       throws java.lang.Exception

Description copied from interface: DeferredUpgradeTask

Run the upgrade that was deferred by an earlier call to doUpgrade.

Throws:: java.lang.Exception

getBuildNumber

public java.lang.String getBuildNumber()

Manually bump this to the latest build number if you want the reindex to be executed.

Specified by:: getBuildNumber in interface UpgradeTaskInfo
Overrides:: getBuildNumber in class AbstractUpgradeTask

Returns:: The build number that this upgrade is applicable to

getShortDescription

public java.lang.String getShortDescription()

Description copied from interface: UpgradeTaskInfo

A short (<50 chars) description of the upgrade action

Specified by:: getShortDescription in interface UpgradeTaskInfo
Overrides:: getShortDescription in class AbstractUpgradeTask

doUpgrade

public void doUpgrade()
               throws java.lang.Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:: doUpgrade in interface UpgradeTask
Overrides:: doUpgrade in class AbstractDeferredRunUpgradeTask

Throws:: java.lang.Exception

runOnSpaceImport

public boolean runOnSpaceImport()

Description copied from interface: BackupSupport

Returns true if an older Space can't be imported in a new instance without running this task. For example:

A task updating macro names in the BodyContent table would be blocking.
Tasks which updates data related to the space would be blocking.
A task upgrading the user table wouldn't be blocking.
Adding a mandatory column on space-related content breaks space import

Note that tasks don't run on space import yet, so we just reject the import in this case.

breaksBackwardCompatibility

public boolean breaksBackwardCompatibility()