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

Interface LiveRelationship

All Superinterfaces:
JSONItem
public interface LiveRelationship extends JSONItem
Defines a live relationship of a synced resource between its blueprint and livecopy. for example, if a site (blueprint) "/content/geometrixx" has a livecopy in "/content/copy", then the resource of "/content/geometrixx/en/jcr:content" and "/content/copy/en/jcr:content" form a relationship. This is also extensible for components within a page, for example the "/content/geometrixx/en/jcr:content/par/title" and "/content/copy/en/jcr:content/par/title" can form a relationship. In contrast to the LiveCopy the LiveRelationship defines the "dynamic" relation between a source and a synced target. where as the former only defines its configuration. Please note that its not possible to have different relative paths from the roots to the source/target resources. This could happen if a source or target resource are moved or renamed. Having trees that are not in sync hirarchy wise will probably end in chaos sooner or later. Such operations need to be prohibited or the respective changes need to be rolledout to all targets.

  • Method Details

    • getLiveCopy

      LiveCopy getLiveCopy()
      Returns the Live Copy configuration of this relationship
      Returns:
      the Live Copy

    • getSyncPath

      String getSyncPath()
      Returns the relative path of this relationship from the sync roots to the actual resources. for example: "/en/jcr:content/par/title" for a paragraph relationship, or "/en/jcr:content" for a page relationship
      Returns:
      the relative path

    • getSourcePath

      String getSourcePath()
      Returns the absolute path of the source resource of this relationship. This is a convenience method for lr.getLiveCopy().getBlueprintPath() + lr.getSyncPath()
      Returns:
      the source path

    • getTargetPath

      String getTargetPath()
      Returns the absolute path of the live sync resource. This is a convenience method for lr.getLiveCopy().getPath() + lr.getSyncPath()
      Returns:
      the target path

    • getStatus

      LiveStatus getStatus()
      Returns the status of this relationship
      Returns:
      the status

    • getRolloutConfigs

      List<RolloutConfig> getRolloutConfigs()
      Returns the computed RolloutConfig of this relationship (blueprint configs + live copy configs)
      Returns:
      the computed configs config

    • getRolloutConfigs

      List<RolloutConfig> getRolloutConfigs(RolloutManager.Trigger trigger)
      Returns the computed RolloutConfig of this relationship (blueprint configs + live copy configs) filtered with the specified trigger.
      Parameters:
      trigger - Filters the list with the specified trigger
      Returns:
      the computed configs config

    • isTrigger

      boolean isTrigger(RolloutManager.Trigger trigger)
      Returns if the current relationship contains at least one RolloutConfig with the specified trigger.
      Parameters:
      trigger - the trigger to check
      Returns:
      true if at least one config as specified trigger, false otherwise.