com.day.cq.wcm.api.msm
Interface RolloutManager

public interface RolloutManager

Provides a service for managing MSM rollouts.

Nested Class Summary

static class

RolloutManager.Trigger Trigger type that defines when a rollout should happen.

Method Summary

boolean	isExcludedNode(Node node) Returns if one of the node types or mixins is defined as excluded in the RolloutManager configuration
boolean	isExcludedNodeType(String nodeType) Returns if a node type is defined as excluded in the RolloutManager configuration
boolean	isExcludedProperty(String propertyName) Returns if a property is defined as excluded in the RolloutManager configuration
void	rollout(Page master, boolean isDeep, RolloutManager.Trigger trigger, String[] targets) Execute a rollout on all the found live copies of the master page.
void	rollout(Page master, RolloutManager.Trigger trigger, String[] targets, String[] paragraphs) Execute a rollout of of the paragraph to all live copies of the of master page.
void	rollout(Page master, RolloutManager.Trigger trigger, String[] targets, String[] paragraphs, boolean delete) Execute a rollout of of the paragraph to all live copies of the of master page.
void	rollout(org.apache.sling.api.resource.ResourceResolver resolver, LiveRelationship relation) Rollout the content for one relation ship.
void	updateRolloutInfo(Node node, boolean deepUpdate, boolean autoSave) Update rollout info on the node.

Method Detail

rollout

void rollout(Page master,
             boolean isDeep,
             RolloutManager.Trigger trigger,
             String[] targets)
             throws WCMException

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,
             RolloutManager.Trigger trigger,
             String[] targets,
             String[] paragraphs)
             throws WCMException

Execute a rollout of 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,
             String[] targets,
             String[] paragraphs,
             boolean delete)
             throws WCMException

Execute a rollout of 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(org.apache.sling.api.resource.ResourceResolver resolver,
             LiveRelationship relation)
             throws WCMException

Rollout the content for one relation ship.

Parameters:

resolver - resource resolver

relation - relation to rollout

Throws:

WCMException - if an error during this operation occurs.

updateRolloutInfo

void updateRolloutInfo(Node node,
                       boolean deepUpdate,
                       boolean autoSave)
                       throws WCMException

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(String propertyName)

Returns if a property is defined as excluded in the RolloutManager configuration

Parameters:

propertyName - repository property name.

Returns:

true if excluded. False otherwise.

isExcludedNodeType

boolean isExcludedNodeType(String nodeType)

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

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.