Package com.day.cq.wcm.api.msm

Interface LiveRelationshipManager

@Deprecated public interface LiveRelationshipManager
Deprecated.
since 5.3 use LiveRelationshipManager instead

  • Method Details

    • getLiveCopies

      Map<String,LiveCopy> getLiveCopies()
      Deprecated.
      Returns all live copies. the Live Copy path is used as key of the map.
      Returns:
      all live copies.

    • getLiveCopy

      LiveCopy getLiveCopy(Resource target)
      Deprecated.
      Returns the closest Live Copy corresponding the target resource.
      Parameters:
      target - resource
      Returns:
      Live Copy or null if no Live Copy found.

    • getLiveRelationships

      Collection<LiveRelationship> getLiveRelationships(Page source, RolloutManager.Trigger trigger, String[] targets, boolean advancedStatus) throws WCMException
      Deprecated.
      Returns a collection of live relationships of the given Live Copy source page to its targets. The search can be limited by trigger or target by specifying the respective parameters. The given source page does not need to be a Live Copy root.
      Parameters:
      source - source page
      trigger - filter for triggers
      targets - filter for targets
      advancedStatus - True if advanced status (time consuming) must be computed for relationships
      Returns:
      the relationships
      Throws:
      WCMException - if an error occurs

    • getLiveRelationships

      Collection<LiveRelationship> getLiveRelationships(Resource source, RolloutManager.Trigger trigger, String[] targets, boolean advancedStatus) throws WCMException
      Deprecated.
      Returns a collection of live relationships of the given livecopy source resource to its targets. The search can be limited by trigger or target by specifying the respective parameters. The given source resource does not need to be a livecopy root.
      Parameters:
      source - resource
      trigger - filter for triggers
      targets - filter for targets
      advancedStatus - True if advanced status (time consuming) must be computed for relationships
      Returns:
      the relationships
      Throws:
      WCMException - if an error occurrs

    • getLiveRelationship

      LiveRelationship getLiveRelationship(Resource target, boolean advancedStatus) throws WCMException
      Deprecated.
      Returns a live relationship of the given livecopy sync resource.
      Parameters:
      target - the livecopy sync resource
      advancedStatus - True if advanced status (time consuming) must be computed for relationship
      Returns:
      the relationship or null if the resource is not a livecopy
      Throws:
      WCMException - if an error occurrs

    • isLiveCopy

      boolean isLiveCopy(Resource target)
      Deprecated.
      Checks if the given sync target is part of a Live Copy relationship.
      Parameters:
      target - the resource to check
      Returns:
      true if the resource is live synced

    • isInBlueprint

      boolean isInBlueprint(Resource source)
      Deprecated.
      Checks if the given source is in a blueprint tree.
      Parameters:
      source - the resource to check
      Returns:
      true if the resource is a blueprint

    • isSource

      boolean isSource(Resource resource)
      Deprecated.
      Checks if the given source is the source of a Live Copy relationship.
      Parameters:
      resource - the resource to check
      Returns:
      true if the resource is a blueprint

    • cancelRelationship

      void cancelRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep, boolean autoSave) throws WCMException
      Deprecated.
      Cancel the relationship of the given relation.
      Parameters:
      resolver - resource resolver
      relation - relation
      deep - if true all child relations are canceled, too
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • reenableRelationship

      void reenableRelationship(ResourceResolver resolver, LiveRelationship relation, boolean autoSave) throws WCMException
      Deprecated.
      Reenable the relationship of a canceled one.
      Parameters:
      resolver - resource resolver
      relation - relation to re-enable
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • toggleRelationship

      void toggleRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep, boolean autoSave) throws WCMException
      Deprecated.
      Cancels or reenables the relationship based on the relation status.
      Parameters:
      resolver - resource resolver
      relation - relation to toggle
      deep - if true all child relations will be cancelled, too
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • cancelPropertyRelationship

      void cancelPropertyRelationship(ResourceResolver resolver, LiveRelationship relation, String[] names, boolean autoSave) throws WCMException
      Deprecated.
      Cancel the relationship of the given relation.
      Parameters:
      resolver - resource resolver
      relation - relation
      names - list of property names for which inheritance is canceled
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • reenablePropertyRelationship

      void reenablePropertyRelationship(ResourceResolver resolver, LiveRelationship relation, String[] names, boolean autoSave) throws WCMException
      Deprecated.
      Reenable the relationship of a canceled one.
      Parameters:
      resolver - resource resolver
      relation - relation to re-enable
      names - list of property names for which inheritance is reenabled
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • cancelRelationship

      @Deprecated void cancelRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep) throws WCMException
      Deprecated.
      Use cancelRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep, boolean autoSave) instead.
      Cancel the relationship of the given relation. Saves the modifications.
      Parameters:
      resolver - resource resolver
      relation - relation
      deep - if true all child relations are canceled, too
      Throws:
      WCMException - if an error occurs

    • reenableRelationship

      @Deprecated void reenableRelationship(ResourceResolver resolver, LiveRelationship relation) throws WCMException
      Deprecated.
      Use reenableRelationship(ResourceResolver resolver, LiveRelationship relation, boolean autoSave) instead.
      Reenable the relationship of a canceled one. Saves the modifications.
      Parameters:
      resolver - resource resolver
      relation - relation to re-enable
      Throws:
      WCMException - if an error occurs

    • toggleRelationship

      @Deprecated void toggleRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep) throws WCMException
      Deprecated.
      Use toggleRelationship(ResourceResolver resolver, LiveRelationship relation, boolean deep, boolean autoSave) instead.
      Cancels or reenables the relationship based on the relation status. Saves the modifications.
      Parameters:
      resolver - resource resolver
      relation - relation to toggle
      deep - if true all child relations will be cancelled, too
      Throws:
      WCMException - if an error occurs

    • getSkippedSourcePages

      Map<String,Page> getSkippedSourcePages(Page parentTargetPage) throws WCMException
      Deprecated.
      Returns a map of pairs: Live Copy skipped page's path / Blueprint page. Each Live Copy skipped page's path is the path of a skipped child of the provided page and returned map contains its corresponding Blueprint page.
      Parameters:
      parentTargetPage - Parent target page
      Returns:
      the map
      Throws:
      WCMException - if an error occurs

    • addSkippedPage

      void addSkippedPage(Page parentPage, String childName, boolean autoSave) throws WCMException
      Deprecated.
      Adds a page to the skipped pages list (stored on parent page).
      Parameters:
      parentPage - Parent page
      childName - Name of the child.
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • addSkippedPages

      void addSkippedPages(Page parentPage, String[] childName, boolean autoSave) throws WCMException
      Deprecated.
      Adds several pages to the skipped pages list (stored on parent page).
      Parameters:
      parentPage - Parent page
      childName - Name of the child.
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • removeSkippedPage

      void removeSkippedPage(Page parentPage, String childName, boolean autoSave) throws WCMException
      Deprecated.
      Removes a page from the skipped pages list (stored on parent page).
      Parameters:
      parentPage - Parent page
      childName - Name of the child.
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs

    • removeSkippedPages

      void removeSkippedPages(Page parentPage, String[] childName, boolean autoSave) throws WCMException
      Deprecated.
      Removes several pages from the skipped pages list (stored on parent page).
      Parameters:
      parentPage - Parent page
      childName - Name of the child.
      autoSave - Save modifications
      Throws:
      WCMException - if an error occurs