Package 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

Version:

$Revision: 25479 $ $Date: 2023-02-28 00:13:03 -0300 (Tue, 28 Feb 2023) $

Method Summary

Modifier and Type	Method	Description
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)	Deprecated. since 8.0.0 replaced by syncIn(String, Set, String, IFile, boolean)
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> removedComponents)	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.

Method Detail

syncIn

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

@Deprecated
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

Deprecated.

since 8.0.0 replaced by syncIn(String, Set, String, IFile, boolean)

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:

java.lang.IllegalArgumentException - if the given tructure root couldn't be relativized using the portal known base folders.

PortalException

Since:

6.2.0

syncOut

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

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

Throws:

PortalException

Since:

7.1.0

syncIn

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

8.0.0

syncIn

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> removedComponents)
     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.

removedComponents - the components that were removed during the deploy that triggered this synchronization.

Throws:

PortalException

Since:

15.0.1