com.atlassian.confluence.upgrade.upgradetask
Class ConvertToRelativeLinksUpgradeTask

java.lang.Object
  extended by com.atlassian.confluence.upgrade.upgradetask.ConvertToRelativeLinksUpgradeTask
All Implemented Interfaces:
BackupSupport, UpgradeTask, UpgradeTaskInfo

public class ConvertToRelativeLinksUpgradeTask
extends Object
implements UpgradeTask, BackupSupport

Converts any absolute links in storage format to relative links. A relative link is defined as a one which either does not have a space key on its ResourceIdentifier or does not have a ResourceIdentifier at all.

This upgrade task is only required on instances that have already had Confluence 4.0 installed.


Field Summary
 
Fields inherited from interface com.atlassian.confluence.upgrade.UpgradeTask
log
 
Constructor Summary
ConvertToRelativeLinksUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager, ContentDao contentDao, BatchTask<ContentEntityObject> batchTask, int applicationConfigBuildNumber)
           
 
Method Summary
 boolean breaksBackwardCompatibility()
          This data cleanup task isn't in response to a format change, so doesn't break backward compatibility.
 void doUpgrade()
          Perform the upgrade.
 String getBuildNumber()
           
 BuildNumberUpgradeConstraint getConstraint()
           
 Collection<UpgradeError> getErrors()
          Return any errors that occur.
 String getName()
          The human-readable name of the upgrade task
 String getShortDescription()
          A short (<50 chars) description of the upgrade action
 boolean isDatabaseUpgrade()
           
 boolean runOnSpaceImport()
          This data cleanup task is a nicety that improves the existing data, but the old data wasn't actually wrong, just suboptimal, and is still valid.
 void validate()
          Validates that this upgrade task can be performed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConvertToRelativeLinksUpgradeTask

public ConvertToRelativeLinksUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                         ContentDao contentDao,
                                         BatchTask<ContentEntityObject> batchTask,
                                         int applicationConfigBuildNumber)
Method Detail

doUpgrade

public void doUpgrade()
               throws Exception
Description copied from interface: UpgradeTask
Perform the upgrade.

Specified by:
doUpgrade in interface UpgradeTask
Throws:
Exception

getBuildNumber

public String getBuildNumber()
Specified by:
getBuildNumber in interface UpgradeTaskInfo
Returns:
The build number that this upgrade is applicable to

getConstraint

public BuildNumberUpgradeConstraint getConstraint()
Specified by:
getConstraint in interface UpgradeTask
Returns:
the constraint that must be passed for this task to be run.

getShortDescription

public String getShortDescription()
Description copied from interface: UpgradeTaskInfo
A short (<50 chars) description of the upgrade action

Specified by:
getShortDescription in interface UpgradeTaskInfo

isDatabaseUpgrade

public boolean isDatabaseUpgrade()
Specified by:
isDatabaseUpgrade in interface UpgradeTaskInfo

validate

public void validate()
              throws Exception
Description copied from interface: UpgradeTask
Validates that this upgrade task can be performed.

Specified by:
validate in interface UpgradeTask
Throws:
Exception

getErrors

public Collection<UpgradeError> getErrors()
Description copied from interface: UpgradeTask
Return any errors that occur. Each entry is an UpgradeError.

Specified by:
getErrors in interface UpgradeTask
Returns:
a collection of UpgradeError objects, sometimes null.

runOnSpaceImport

public boolean runOnSpaceImport()
This data cleanup task is a nicety that improves the existing data, but the old data wasn't actually wrong, just suboptimal, and is still valid. So this task does not prevent Space Import. It should be fairly simple to adapt it to fix just the data in a single space.

Specified by:
runOnSpaceImport in interface BackupSupport

breaksBackwardCompatibility

public boolean breaksBackwardCompatibility()
This data cleanup task isn't in response to a format change, so doesn't break backward compatibility.

Specified by:
breaksBackwardCompatibility in interface BackupSupport

getName

public String getName()
Description copied from interface: UpgradeTaskInfo
The human-readable name of the upgrade task

Specified by:
getName in interface UpgradeTaskInfo


Copyright © 2003–2015 Atlassian. All rights reserved.