Package lumis.portal.structure.sync

Class StructureSyncManager

java.lang.Object

lumis.portal.structure.sync.StructureSyncManager

All Implemented Interfaces:

IStructureSyncManager

public class StructureSyncManager
extends java.lang.Object
implements IStructureSyncManager

Structure synchronization manager implementation.

Since:

6.2.0

Version:

$Revision: 26431 $ $Date: 2024-06-06 16:19:46 -0300 (Thu, 06 Jun 2024) $

Constructor Summary

Constructors

Constructor	Description
StructureSyncManager()

Method Summary

Modifier and Type	Method	Description
IFile	getDefaultStructureRoot()
void	syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, boolean clearHtmlCache)	Synchronizes a structure from the file system to the portal database.
void	syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, java.io.File structureRoot, boolean clearHtmlCache)	Synchronizes a structure from the file system to the portal database.
void	syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache)	Synchronizes a structure from the file system to the portal database.
void	syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache, java.util.Collection<IComponent> affectedComponents)	Synchronizes a structure from the file system to the portal database.
void	syncOut(java.lang.String rootChannelId, java.lang.String processId, java.util.Set<java.lang.String> globalGroupsToBeExported)	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

Constructor Detail

StructureSyncManager

public StructureSyncManager()

Method Detail

syncIn

public void syncIn(java.lang.String rootChannelId,
                   java.util.Set<java.lang.String> selectedElements,
                   java.lang.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(java.lang.String rootChannelId,
                   java.util.Set<java.lang.String> selectedElements,
                   java.lang.String processId,
                   java.io.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

syncIn

public void syncIn(java.lang.String rootChannelId,
                   java.util.Set<java.lang.String> selectedElements,
                   java.lang.String processId,
                   IFile 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

syncIn

public void syncIn(java.lang.String rootChannelId,
                   java.util.Set<java.lang.String> selectedElements,
                   java.lang.String processId,
                   IFile structureRoot,
                   boolean clearHtmlCache,
                   java.util.Collection<IComponent> affectedComponents)
            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.

affectedComponents - the components that were affected during the deploy that triggered this synchronization.

Throws:

PortalException

syncOut

public void syncOut(java.lang.String rootChannelId,
                    java.lang.String processId,
                    java.util.Set<java.lang.String> globalGroupsToBeExported)
             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.

globalGroupsToBeExported - the identifiers of the global groups that should be exported.

Throws:

PortalException

getDefaultStructureRoot

public IFile getDefaultStructureRoot()