com.atlassian.confluence.upgrade.upgradetask
Class ReportUserMacrosWithWikiTemplateUpgradeTask

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

All Implemented Interfaces:

DeferredUpgradeTask, UpgradeTask

public class ReportUserMacrosWithWikiTemplateUpgradeTask
extends AbstractDeferredRunUpgradeTask

This isn't really an upgrade task, it is just convenient for it to run at that time. This task looks at all the user macros configured in the system and outputs a warning to the logs for any that have wiki templates. These wiki template macros are deprecated in the XHTML version of Confluence.

Field Summary

Fields inherited from interface com.atlassian.confluence.upgrade.UpgradeTask

log

Constructor Summary

ReportUserMacrosWithWikiTemplateUpgradeTask(UserMacroLibrary library, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

void	doDeferredUpgrade() Run the upgrade that was deferred by an earlier call to doUpgrade.
String	getBuildNumber()
String	getShortDescription() A short (<50 chars) description of the upgrade action

Methods inherited from class com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

doUpgrade, isUpgradeRequired, setUpgradeRequired

Methods inherited from class com.atlassian.confluence.upgrade.AbstractUpgradeTask

addAllErrors, addError, addError, getConstraint, getErrors, 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

Constructor Detail

ReportUserMacrosWithWikiTemplateUpgradeTask

public ReportUserMacrosWithWikiTemplateUpgradeTask(UserMacroLibrary library,
                                                   com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

doDeferredUpgrade

public void doDeferredUpgrade()
                       throws Exception

Description copied from interface: DeferredUpgradeTask

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

Throws:

Exception

getBuildNumber

public String getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTask

Overrides:

getBuildNumber in class AbstractUpgradeTask

Returns:

The build number that this upgrade is applicable to

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTask

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

Specified by:

getShortDescription in interface UpgradeTask

Overrides:

getShortDescription in class AbstractUpgradeTask