lumis.portal.structure.sync
Class StructureSyncManager

java.lang.Object
  lumis.portal.structure.sync.StructureSyncManager

All Implemented Interfaces:

IStructureSyncManager

public class StructureSyncManager
extends Object
implements IStructureSyncManager

Structure synchronization manager implementation.

Since:

6.2.0

Field Summary

static String

DEFAULT_STRUCTURE_ROOT_SYSTEM_PROPERTY_NAME

Constructor Summary

StructureSyncManager()

Method Summary

void	deleteRestorePoint(String restorePointFileName) Deletes the restore point with the given name, if it exist.
File	getDefaultStructureRoot()
void	syncIn(String rootChannelId, Set<String> selectedElements, String processId, boolean clearHtmlCache) Synchronizes a structure from the file system to the portal database.
void	syncIn(String rootChannelId, Set<String> selectedElements, String processId, File structureRoot, boolean clearHtmlCache) Synchronizes a structure from the file system to the portal database.
void	syncOut(String rootChannelId, String processId) Synchronizes a structure from the portal database to the file system.
void	syncOut(String rootChannelId, String processId, File structureRoot) Synchronizes a structure from the portal database to the file system.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STRUCTURE_ROOT_SYSTEM_PROPERTY_NAME

public static final String DEFAULT_STRUCTURE_ROOT_SYSTEM_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

StructureSyncManager

public StructureSyncManager()

Method Detail

syncIn

public void syncIn(String rootChannelId,
                   Set<String> selectedElements,
                   String processId,
                   boolean clearHtmlCache)
            throws PortalException

Description copied from interface: IStructureSyncManager

Synchronizes a structure from the file system to the portal database.

Specified by:

syncIn in interface IStructureSyncManager

Parameters:

rootChannelId - the root of the structure tree to be synchronized.

selectedElements - the path of the elements, within the tree, selected to be synchronized. A directory selected implies the synchronization of its children. The paths are relative to the structure root (e.g.: "portal/mychannel/pg_mypage.xml").

processId - the process identifier for progress bar updates.

clearHtmlCache - indicates whether the HTML cache should be cleared.

Throws:

PortalException

syncIn

public void syncIn(String rootChannelId,
                   Set<String> selectedElements,
                   String processId,
                   File structureRoot,
                   boolean clearHtmlCache)
            throws PortalException

Description copied from interface: IStructureSyncManager

Synchronizes a structure from the file system to the portal database.

Specified by:

syncIn in interface IStructureSyncManager

Parameters:

rootChannelId - the root of the structure tree to be synchronized.

selectedElements - the path of the elements, within the tree, selected to be synchronized. A directory selected implies the synchronization of its children. The paths are relative to the structure root (e.g.: "portal/mychannel/pg_mypage.xml").

processId - the process identifier for progress bar updates.

structureRoot - the directory that is the root of the structure file system to be used.

clearHtmlCache - indicates whether the HTML cache should be cleared.

Throws:

PortalException

syncOut

public void syncOut(String rootChannelId,
                    String processId)
             throws PortalException

Description copied from interface: IStructureSyncManager

Synchronizes a structure from the portal database to the file system.

Specified by:

syncOut in interface IStructureSyncManager

Parameters:

rootChannelId - the root of the structure tree to be synchronized.

processId - the process identifier for progress bar updates.

Throws:

PortalException

syncOut

public void syncOut(String rootChannelId,
                    String processId,
                    File structureRoot)
             throws PortalException

Description copied from interface: IStructureSyncManager

Synchronizes a structure from the portal database to the file system.

Specified by:

syncOut in interface IStructureSyncManager

Parameters:

rootChannelId - the root of the structure tree to be synchronized.

processId - the process identifier for progress bar updates.

structureRoot - the directory that is the root of the structure file system to be used.

Throws:

PortalException

getDefaultStructureRoot

public File getDefaultStructureRoot()

deleteRestorePoint

public void deleteRestorePoint(String restorePointFileName)
                        throws PortalException

Description copied from interface: IStructureSyncManager

Deletes the restore point with the given name, if it exist.

Specified by:

deleteRestorePoint in interface IStructureSyncManager

Parameters:

restorePointFileName - the restore point directory name. It is the name of the directory child of lumisdata/structure/restorepoint.

Throws:

PortalException - if an error occurred during the operation.