com.atlassian.confluence.upgrade.upgradetask
Class HierarchicalFileSystemAttachmentUpgradeTask

java.lang.Object
  com.atlassian.confluence.upgrade.upgradetask.HierarchicalFileSystemAttachmentUpgradeTask

All Implemented Interfaces:

UpgradeTask

public class HierarchicalFileSystemAttachmentUpgradeTask
extends java.lang.Object
implements UpgradeTask

Field Summary

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

log

Constructor Summary

HierarchicalFileSystemAttachmentUpgradeTask(FileLocationResolver attachmentsDirectoryResolver, AttachmentManager attachmentManager, net.sf.hibernate.SessionFactory sessionFactory, HierarchicalFileSystemAttachmentDataDao dataDao, IdMultiPartHashGenerator multiPartHashGenerator)

Method Summary

void	doUpgrade() If this instance of Confluence is configured to store attachments on the file system then this task will migrate the attachments to a new hierarchical structure.
java.lang.String	getBuildNumber()
java.util.Collection<UpgradeError>	getErrors() Return any errors that occur.
java.lang.String	getShortDescription() A short (<50 chars) description of the upgrade action
boolean	isUpgradeNeeded() Based on the configuration of the Confluence AttachmentManager decide on whether this upgrade task should be run.

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalFileSystemAttachmentUpgradeTask

public HierarchicalFileSystemAttachmentUpgradeTask(FileLocationResolver attachmentsDirectoryResolver,
                                                   AttachmentManager attachmentManager,
                                                   net.sf.hibernate.SessionFactory sessionFactory,
                                                   HierarchicalFileSystemAttachmentDataDao dataDao,
                                                   IdMultiPartHashGenerator multiPartHashGenerator)

Method Detail

doUpgrade

public void doUpgrade()
               throws java.lang.Exception

If this instance of Confluence is configured to store attachments on the file system then this task will migrate the attachments to a new hierarchical structure.

If non file system storage (e.g. Database) of attachments is used then this upgrade task will log the fact that it is doing nothing.

Specified by:

doUpgrade in interface UpgradeTask

Throws:

java.lang.Exception

isUpgradeNeeded

public boolean isUpgradeNeeded()

Based on the configuration of the Confluence AttachmentManager decide on whether this upgrade task should be run.

Returns:

true if the task can be run; otherwise false.

getBuildNumber

public java.lang.String getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTask

Returns:

The build number that this upgrade is applicable to

getErrors

public java.util.Collection<UpgradeError> getErrors()

Description copied from interface: UpgradeTask

Return any errors that occur. Each entry is an UpgradeError.

Specified by:

getErrors in interface UpgradeTask

getShortDescription

public java.lang.String getShortDescription()

Description copied from interface: UpgradeTask

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

Specified by:

getShortDescription in interface UpgradeTask