|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.database.DbArchiveManager
public class DbArchiveManager
Database implementation of the ArchiveManager interface.
Nested Class Summary | |
---|---|
class |
DbArchiveManager.ArchiveTask
A task to be run in the TaskEngine that executes an archiving run. |
Field Summary | |
---|---|
static java.lang.String |
ARCHIVED_PROP
|
static java.lang.String |
ARCHIVING_DISABLED_PROP
|
Fields inherited from interface com.jivesoftware.forum.ArchiveManager |
---|
DELETE_THREADS, MARK_THREADS, MOVE_THREADS |
Constructor Summary | |
---|---|
DbArchiveManager()
|
Method Summary | |
---|---|
void |
destroy()
Notifies the manager to release any resources that may be holding on too. |
int |
getArchiveDays(Forum forum)
Returns the number of days that threads in forum must be inactive before being archived. |
Forum |
getArchiveForum(Forum forum)
Returns the "archive forum" for the specified forum. |
int |
getArchiveMode(Forum forum)
Returns the archive mode for the forum. |
int |
getAutoArchiveInterval()
Returns the inverval between auto archive executions (in hours). |
java.util.Date |
getLastArchivedDate()
Returns the date the archiving process was last run. |
void |
initialize()
Initialize the manager. |
boolean |
isArchivingEnabled(Forum forum)
Returns true if archiving is enabled for the specified forum. |
boolean |
isAutoArchiveEnabled()
Returns true if auto-archiving is enabled. |
boolean |
isBusy()
Returns true if the archiving process is currently running. |
void |
run()
|
void |
runArchiver()
Manually runs the archiving process. |
void |
setArchiveDays(Forum forum,
int days)
Sets the number of days that threads in forum must be inactive before being archived. |
void |
setArchiveForum(Forum forum,
Forum archiveForum)
Sets the "archive forum" for the specified forum. |
void |
setArchiveMode(Forum forum,
int mode)
Returns the archive mode for the forum. |
void |
setArchivingEnabled(Forum forum,
boolean enabled)
Enables or disables archiving for the specified forum. |
void |
setAutoArchiveEnabled(boolean enabled)
Enables or disables auto-archiving. |
void |
setAutoArchiveInterval(int interval)
Sets the inverval between auto archive executions (in hours). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ARCHIVING_DISABLED_PROP
public static final java.lang.String ARCHIVED_PROP
Constructor Detail |
---|
public DbArchiveManager()
Method Detail |
---|
public void initialize()
JiveManager
This method is used internally by Jive during application startup and should not be called during normal usage of the class.
initialize
in interface JiveManager
public void destroy()
JiveManager
destroy
in interface JiveManager
public boolean isArchivingEnabled(Forum forum)
ArchiveManager
isArchivingEnabled
in interface ArchiveManager
forum
- the forum to check the status of.
public void setArchivingEnabled(Forum forum, boolean enabled)
ArchiveManager
setArchivingEnabled
in interface ArchiveManager
forum
- the forum to set the status of.enabled
- true if archiving should be enabled for the forum.public int getArchiveDays(Forum forum)
ArchiveManager
getArchiveDays
in interface ArchiveManager
forum
- the forum to check the value on.
public void setArchiveDays(Forum forum, int days)
ArchiveManager
setArchiveDays
in interface ArchiveManager
forum
- the forum to set the value on.days
- the number of days a thread must be inactive before being
archived.public int getArchiveMode(Forum forum)
ArchiveManager
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
getArchiveMode
in interface ArchiveManager
forum
- the forum to check the archive mode of.
public void setArchiveMode(Forum forum, int mode)
ArchiveManager
If the MOVE_THREADS mode is being used, an "archive forum" must be specified to move archived threads to.
setArchiveMode
in interface ArchiveManager
forum
- the forum to set the archive mode of.mode
- the archive mode.public Forum getArchiveForum(Forum forum)
ArchiveManager
getArchiveForum
in interface ArchiveManager
forum
- the forum to get the "archive forum" of.
public void setArchiveForum(Forum forum, Forum archiveForum)
ArchiveManager
setArchiveForum
in interface ArchiveManager
forum
- the forum to set the "archive forum" of.archiveForum
- the "archive forum" for public boolean isAutoArchiveEnabled()
ArchiveManager
isAutoArchiveEnabled
in interface ArchiveManager
public void setAutoArchiveEnabled(boolean enabled)
ArchiveManager
setAutoArchiveEnabled
in interface ArchiveManager
enabled
- true if auto-archiving should be enabled.public int getAutoArchiveInterval()
ArchiveManager
getAutoArchiveInterval
in interface ArchiveManager
public void setAutoArchiveInterval(int interval)
ArchiveManager
setAutoArchiveInterval
in interface ArchiveManager
interval
- the interval betwen auto archive executions (in hours).public java.util.Date getLastArchivedDate()
ArchiveManager
getLastArchivedDate
in interface ArchiveManager
public boolean isBusy() throws UnauthorizedException
ArchiveManager
isBusy
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public void runArchiver() throws UnauthorizedException
ArchiveManager
runArchiver
in interface ArchiveManager
UnauthorizedException
- if not a system administrator.public void run()
run
in interface java.lang.Runnable
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |