Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.upgrade
Interface UpgradeTask

All Known Implementing Classes:
AbstractDatabaseUpgradeTask, AddHostNameFilter, AddIndexesTask, AddTagIndexes, CreateAutoSave, CreateCommunityEverywhere, CreatePostReplyViaEmail, CreateTags, CreateVersionTable, EncryptLdapPasswordTask, MigrateLocalCacheProperties, ModifyAttachmentContentTypeSize, ModifyUserProfileSize, ModifyUserProfileSize2, ResetHTMLFilterValuesUpgradeTask, StripMessageTokensFromWatchTemplates, TestUpgradeTask, UpdateDigestEmailTemplate, UpdateFilters, UpdateRootCategoryLocale, Version410

public interface UpgradeTask

Interface that all community upgrade tasks should implement. Note: UpgradeTasks should make changes to the database directly and should not rely on the API. It is acceptable to use static utility classes such as JiveGlobals or JiveConstants.

Since:
5.1.0

Method Summary
 void doTask()
          Executes the upgrade task
 java.lang.String getDescription()
          Upgrade task description
 java.lang.String getEstimatedRunTime()
          Upgrade task estimated run time
 java.lang.String getInstructionsFile()
          Returns the name of the manual instructions file that will be displayed if the task fails.
 java.lang.String getName()
          Upgrade task name
 

Method Detail

getName

java.lang.String getName()
Upgrade task name


getDescription

java.lang.String getDescription()
Upgrade task description


getEstimatedRunTime

java.lang.String getEstimatedRunTime()
Upgrade task estimated run time


getInstructionsFile

java.lang.String getInstructionsFile()
Returns the name of the manual instructions file that will be displayed if the task fails. All instructions files will be loaded from com/jivesoftware/forum/upgrade/instructions/ and will have .txt appended to the end of the name.


doTask

void doTask()
            throws java.sql.SQLException,
                   java.io.IOException,
                   java.lang.Exception
Executes the upgrade task

Throws:
java.sql.SQLException
java.io.IOException
java.lang.Exception

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.