Class StructureSyncManager

  • All Implemented Interfaces:
    IStructureSyncManager

    public class StructureSyncManager
    extends Object
    implements IStructureSyncManager
    Structure synchronization manager implementation.
    Since:
    6.2.0
    Version:
    $Revision: 17047 $ $Date: 2015-03-03 11:22:22 -0300 (Tue, 03 Mar 2015) $
    • 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
      • syncIn

        public void syncIn​(String rootChannelId,
                           Set<String> selectedElements,
                           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
      • syncOut

        public void syncOut​(String rootChannelId,
                            String processId,
                            Set<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()