lumis.portal.structure.sync
Interface IStructureSyncManager

All Known Implementing Classes:

StructureSyncManager

public interface IStructureSyncManager

Provides structure synchronization between the portal database and the file system.

Since:

6.2.0

Method Summary

void	deleteRestorePoint(String restorePointFileName) Deletes the restore point with the given name, if it exist.
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.

Method Detail

syncIn

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

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

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

Since:

6.2.0

syncIn

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

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

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

Since:

6.2.0

syncOut

void syncOut(String rootChannelId,
             String processId)
             throws PortalException

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

Parameters:

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

processId - the process identifier for progress bar updates.

Throws:

PortalException

Since:

6.2.0

syncOut

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

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

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

Since:

6.2.0

deleteRestorePoint

void deleteRestorePoint(String restorePointFileName)
                        throws PortalException

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

Parameters:

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

Throws:

IllegalArgumentException - if restorePointFileName is not a valid name for a restore point.

PortalException - if an error occurred during the operation.

Since:

6.2.0