Interface RolloutManager


  • @Deprecated
    public interface RolloutManager
    Deprecated.
    since 5.3 use RolloutManager instead
    Provides a service for managing MSM rollouts.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  RolloutManager.Trigger
      Deprecated.
      Trigger type that defines when a rollout should happen.
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean isExcludedNode​(Node node)
      Deprecated.
      Returns if one of the node types or mixins is defined as excluded in the RolloutManager configuration
      boolean isExcludedNodeType​(java.lang.String nodeType)
      Deprecated.
      Returns if a node type is defined as excluded in the RolloutManager configuration
      boolean isExcludedPageProperty​(java.lang.String propertyName)
      Deprecated.
      Returns if a property is defined as excluded in the RolloutManager configuration for a page.
      boolean isExcludedParagraphProperty​(java.lang.String propertyName)
      Deprecated.
      Returns if a property is defined as excluded in the RolloutManager configuration for a paragraph.
      boolean isExcludedProperty​(boolean isPage, java.lang.String propertyName)
      Deprecated.
      Returns if a property is defined as excluded in the RolloutManager configuration.
      boolean isExcludedProperty​(java.lang.String propertyName)
      Deprecated.
      Use #isExcludedPageProperty instead.
      boolean isReservedProperty​(java.lang.String propertyName)
      Deprecated.
      Returns if a property is a MSM reserved property
      void rollout​(Page master, boolean isDeep, RolloutManager.Trigger trigger, boolean reset, java.lang.String[] targets)
      Deprecated.
      Execute a rollout on all the found live copies of the master page.
      void rollout​(Page master, boolean isDeep, RolloutManager.Trigger trigger, java.lang.String[] targets)
      Deprecated.
      Execute a rollout on all the found live copies of the master page.
      void rollout​(Page master, RolloutManager.Trigger trigger, boolean reset, java.lang.String[] targets, java.lang.String[] paragraphs)
      Deprecated.
      Execute a rollout of the paragraph to all live copies of the of master page.
      void rollout​(Page master, RolloutManager.Trigger trigger, boolean reset, java.lang.String[] targets, java.lang.String[] paragraphs, boolean delete)
      Deprecated.
      Execute a rollout of the paragraph to all live copies of the of master page.
      void rollout​(Page master, RolloutManager.Trigger trigger, java.lang.String[] targets, java.lang.String[] paragraphs)
      Deprecated.
      Execute a rollout of the paragraph to all live copies of the of master page.
      void rollout​(Page master, RolloutManager.Trigger trigger, java.lang.String[] targets, java.lang.String[] paragraphs, boolean delete)
      Deprecated.
      Execute a rollout of the paragraph to all live copies of the of master page.
      void rollout​(ResourceResolver resolver, LiveRelationship relation)
      Deprecated.
      Rollout the content for one relation ship.
      void rollout​(ResourceResolver resolver, LiveRelationship relation, boolean reset)
      Deprecated.
      Rollout the content for one relation ship.
      void updateRolloutInfo​(Node node, boolean deepUpdate, boolean autoSave)
      Deprecated.
      Update rollout info on the node.
    • Method Detail

      • rollout

        void rollout​(Page master,
                     boolean isDeep,
                     RolloutManager.Trigger trigger,
                     java.lang.String[] targets)
              throws WCMException
        Deprecated.
        Execute a rollout on all the found live copies of the master page.
        Parameters:
        master - master page to rollout
        trigger - rollout trigger
        targets - paths of live copies to update. null for all.
        isDeep - if true all child pages are updated, too.
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(Page master,
                     boolean isDeep,
                     RolloutManager.Trigger trigger,
                     boolean reset,
                     java.lang.String[] targets)
              throws WCMException
        Deprecated.
        Execute a rollout on all the found live copies of the master page.
        Parameters:
        master - master page to rollout
        trigger - rollout trigger
        reset - if true rollout is run in reset mode, Live Copy is completely reset
        targets - paths of live copies to update. null for all.
        isDeep - if true all child pages are updated, too.
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(Page master,
                     RolloutManager.Trigger trigger,
                     java.lang.String[] targets,
                     java.lang.String[] paragraphs)
              throws WCMException
        Deprecated.
        Execute a rollout of the paragraph to all live copies of the of master page.
        Parameters:
        master - Master page to rollout
        paragraphs - (absolute) paths of paragraphs
        trigger - rollout trigger
        targets - paths of live copies to update. null for all.
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(Page master,
                     RolloutManager.Trigger trigger,
                     boolean reset,
                     java.lang.String[] targets,
                     java.lang.String[] paragraphs)
              throws WCMException
        Deprecated.
        Execute a rollout of the paragraph to all live copies of the of master page.
        Parameters:
        master - Master page to rollout
        trigger - rollout trigger
        reset - if true rollout is run in reset mode, Live Copy is completely reset
        targets - paths of live copies to update. null for all.
        paragraphs - (absolute) paths of paragraphs
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(Page master,
                     RolloutManager.Trigger trigger,
                     java.lang.String[] targets,
                     java.lang.String[] paragraphs,
                     boolean delete)
              throws WCMException
        Deprecated.
        Execute a rollout of the paragraph to all live copies of the of master page. If delete is true, the paragraph is deleted and then rolledout.
        Parameters:
        master - Master page to rollout
        paragraphs - (absolute) paths of paragraphs
        trigger - rollout trigger
        targets - paths of live copies to update. null for all.
        delete - true if paragraph should be deleted
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(Page master,
                     RolloutManager.Trigger trigger,
                     boolean reset,
                     java.lang.String[] targets,
                     java.lang.String[] paragraphs,
                     boolean delete)
              throws WCMException
        Deprecated.
        Execute a rollout of the paragraph to all live copies of the of master page. If delete is true, the paragraph is deleted and then rolledout.
        Parameters:
        master - Master page to rollout
        paragraphs - (absolute) paths of paragraphs
        trigger - rollout trigger
        reset - if true rollout is run in reset mode, Live Copy is completely reset
        targets - paths of live copies to update. null for all.
        delete - true if paragraph should be deleted
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(ResourceResolver resolver,
                     LiveRelationship relation)
              throws WCMException
        Deprecated.
        Rollout the content for one relation ship.
        Parameters:
        resolver - resource resolver
        relation - relation to rollout
        Throws:
        WCMException - if an error during this operation occurs.
      • rollout

        void rollout​(ResourceResolver resolver,
                     LiveRelationship relation,
                     boolean reset)
              throws WCMException
        Deprecated.
        Rollout the content for one relation ship.
        Parameters:
        resolver - resource resolver
        relation - relation to rollout
        reset - if true rollout is run in reset mode, Live Copy is completely reset
        Throws:
        WCMException - if an error during this operation occurs.
      • updateRolloutInfo

        void updateRolloutInfo​(Node node,
                               boolean deepUpdate,
                               boolean autoSave)
                        throws WCMException
        Deprecated.
        Update rollout info on the node. To use after a rollout operation.
        Parameters:
        node - Node to update
        deepUpdate - Children of the node can be updated by setting deepUpdate to true.
        autoSave - Save modifications
        Throws:
        WCMException - if an error during this operation occurs.
      • isExcludedProperty

        boolean isExcludedProperty​(java.lang.String propertyName)
        Deprecated.
        Use #isExcludedPageProperty instead.
        Returns if a property is defined as excluded in the RolloutManager configuration. Excluded properties include reserved properties.
        Parameters:
        propertyName - repository property name.
        Returns:
        true if excluded. False otherwise.
      • isExcludedProperty

        boolean isExcludedProperty​(boolean isPage,
                                   java.lang.String propertyName)
        Deprecated.
        Returns if a property is defined as excluded in the RolloutManager configuration. If isPage is true, checks in page exclusion list. Otherwise, check in paragraph exclusion list Excluded properties include reserved properties.
        Parameters:
        isPage - Page property
        propertyName - repository property name.
        Returns:
        true if excluded. False otherwise.
      • isExcludedPageProperty

        boolean isExcludedPageProperty​(java.lang.String propertyName)
        Deprecated.
        Returns if a property is defined as excluded in the RolloutManager configuration for a page. Excluded properties include reserved properties.
        Parameters:
        propertyName - repository property name.
        Returns:
        true if excluded. False otherwise.
      • isExcludedParagraphProperty

        boolean isExcludedParagraphProperty​(java.lang.String propertyName)
        Deprecated.
        Returns if a property is defined as excluded in the RolloutManager configuration for a paragraph. Excluded properties include reserved properties.
        Parameters:
        propertyName - repository property name.
        Returns:
        true if excluded. False otherwise.
      • isExcludedNodeType

        boolean isExcludedNodeType​(java.lang.String nodeType)
        Deprecated.
        Returns if a node type is defined as excluded in the RolloutManager configuration
        Parameters:
        nodeType - repository node type.
        Returns:
        true if excluded. False otherwise.
      • isExcludedNode

        boolean isExcludedNode​(Node node)
                        throws RepositoryException
        Deprecated.
        Returns if one of the node types or mixins is defined as excluded in the RolloutManager configuration
        Parameters:
        node - node to check.
        Returns:
        true if excluded. False otherwise.
        Throws:
        RepositoryException - if an read/write error during this operation occurs.
      • isReservedProperty

        boolean isReservedProperty​(java.lang.String propertyName)
        Deprecated.
        Returns if a property is a MSM reserved property
        Parameters:
        propertyName - repository property name.
        Returns:
        true if reserved. False otherwise.