de.innovationgate.webgate.api.utils

Class ContentStoreDumpManager

java.lang.Object

de.innovationgate.webgate.api.utils.ContentStoreDumpManager

public class ContentStoreDumpManager
extends java.lang.Object

Tool class to export and import content store dumps between OpenWGA content stores. This class itself does not create the OpenWGA content store dump format ".wgacs" which is essentially a zipped HSQLDB content store. It just performs the data pumping task.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	UNMIGRATEABLE_DBMETADATA Extension data fields on the database which should not be migrated as they represent local database state that should not be transferred

Constructor Summary

Constructors

Constructor and Description
ContentStoreDumpManager(WGDatabase from, WGDatabase to) Constructor
ContentStoreDumpManager(WGDatabase from, WGDatabase to, org.apache.log4j.Logger logger) Construtor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exportDump() Exports an OpenWGA content store dump from a content store.
boolean	exportDump(boolean includeACL) Exports an OpenWGA content store dump from a content store.
boolean	exportDump(boolean includeACL, boolean includeSystemAreas, boolean includeArchived) Exports an OpenWGA content store dump from a content store.
int	getClearCacheEvery() Returns after how much processed documents the database caches are cleared to free memory.
boolean	importDump() Imports an OpenWGA content store dump into a content store.
boolean	importDump(boolean includeACL) Imports an OpenWGA content store dump into a content store.
boolean	importDump(boolean includeACL, boolean includeSystemAreas) Imports an OpenWGA content store dump into a content store.
void	setClearCacheEvery(int i) Sets after how much processed documents the database caches are cleared to free memory.

Methods inherited from class java.lang.Object

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

Field Detail

UNMIGRATEABLE_DBMETADATA

public static final java.util.List<java.lang.String> UNMIGRATEABLE_DBMETADATA

Extension data fields on the database which should not be migrated as they represent local database state that should not be transferred

Constructor Detail

ContentStoreDumpManager

public ContentStoreDumpManager(WGDatabase from,
                       WGDatabase to,
                       org.apache.log4j.Logger logger)

Construtor

Parameters:

from - The source database

to - The target database

logger - A logger to write the dump log to

ContentStoreDumpManager

public ContentStoreDumpManager(WGDatabase from,
                       WGDatabase to)

Constructor

Parameters:

from - The source database

to - The target database

Method Detail

importDump

public boolean importDump()
                   throws WGAPIException

Imports an OpenWGA content store dump into a content store. Database "from" must be the dump database and "to" the content store.

Returns:

true if the dump import succeeeded, false if it was canceled.

Throws:

WGAPIException

importDump

public boolean importDump(boolean includeACL,
                 boolean includeSystemAreas)
                   throws WGAPIException

Imports an OpenWGA content store dump into a content store. Database "from" must be the dump database and "to" the content store.

Parameters:

includeACL - should the ACL of the source be imported or not

includeSystemAreas - should system areas be imported or not

Returns:

true if the dump import succeeeded, false if it was canceled.

Throws:

WGAPIException

importDump

public boolean importDump(boolean includeACL)
                   throws WGAPIException

Imports an OpenWGA content store dump into a content store. Database "from" must be the dump database and "to" the content store.

Parameters:

includeACL - should the ACL of the source be imported or not

Returns:

true if the dump import succeeeded, false if it was canceled.

Throws:

WGAPIException

exportDump

public boolean exportDump()
                   throws WGAPIException

Exports an OpenWGA content store dump from a content store. Database "from" must be the content store and "to" the soon-to-be dump database.

Returns:

true if the dump succeeeded, false if it was canceled

Throws:

WGAPIException

exportDump

public boolean exportDump(boolean includeACL)
                   throws WGAPIException

Exports an OpenWGA content store dump from a content store. Database "from" must be the content store and "to" the soon-to-be dump database.

Parameters:

includeACL - should the ACL of the source be included in the dump or not

Returns:

true if the dump succeeeded, false if it was canceled

Throws:

WGAPIException

exportDump

public boolean exportDump(boolean includeACL,
                 boolean includeSystemAreas,
                 boolean includeArchived)
                   throws WGAPIException

Exports an OpenWGA content store dump from a content store. Database "from" must be the content store and "to" the soon-to-be dump database.

Parameters:

includeACL - should the ACL of the source be included in the dump or not

includeSystemAreas - should system areas be included in the dump or not

includeArchived -

Returns:

true if the dump succeeeded, false if it was canceled

Throws:

WGAPIException

getClearCacheEvery

public int getClearCacheEvery()

Returns after how much processed documents the database caches are cleared to free memory. The default is 100.

setClearCacheEvery

public void setClearCacheEvery(int i)

Sets after how much processed documents the database caches are cleared to free memory.

Parameters:

i -