Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.upgrade
Class UpgradeManager

java.lang.Object
  extended by com.jivesoftware.forum.upgrade.UpgradeManager

public class UpgradeManager
extends java.lang.Object

Manages the community upgrade framework. The manager uses the jiveVersion database table to figure out which database schema is currently installed and then attempts to automatically apply database schema changes as necessary.

Running database schemas automatically requires appropriate database permissions. Without those permissions, the automatic installation/upgrade process will fail and users will be prompted to apply database changes manually.

Since:
5.1.0

Method Summary
 UpgradeTask getCurrentTask()
           
 UpgradeTaskException getException()
           
 java.util.Map getFinishedTasks()
           
static UpgradeManager getInstance()
           
 java.util.Map getPendingTasks()
           
 boolean isRunning()
           
 boolean isUpgraded()
           
 boolean isUpgradeStarted()
           
 boolean isVersionTableExists()
           
 void restart()
           
 void skip()
           
 void start()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static UpgradeManager getInstance()

isUpgraded

public boolean isUpgraded()

getPendingTasks

public java.util.Map getPendingTasks()

getFinishedTasks

public java.util.Map getFinishedTasks()

getCurrentTask

public UpgradeTask getCurrentTask()

getException

public UpgradeTaskException getException()

start

public void start()

restart

public void restart()

isRunning

public boolean isRunning()

skip

public void skip()

isVersionTableExists

public boolean isVersionTableExists()

isUpgradeStarted

public boolean isUpgradeStarted()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.