com.day.cq.wcm.msm.api

Interface RolloutManager

public interface RolloutManager

Provides a service for managing MSM rollouts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RolloutManager.RolloutParams Parameters for rollouts, with default values
static interface	RolloutManager.RolloutProgress Used to report ongoing progress of a rollout
static class	RolloutManager.Trigger Trigger type that defines when a rollout should happen.

Method Summary

Modifier and Type	Method and Description
boolean	isExcludedNode(Node node) If true the given Node will not take part in a roll out. If one of the Node's PrimaryNodeType or one of its mixin NodeTypes is excluded, this method must return true. Implementations can extend rules to exclude Nodes from Inheritance for example to exclude protected Nodes
boolean	isExcludedNodeType(java.lang.String nodeType) Returns true if a NodeType is configured as excluded in the RolloutManager configuration
boolean	isExcludedPageProperty(java.lang.String propertyName) Returns if a property is defined as excluded in the RolloutManager configuration for a page.
boolean	isExcludedParagraphProperty(java.lang.String propertyName) Returns if a property is defined as excluded in the RolloutManager configuration for a paragraph.
boolean	isExcludedProperty(boolean isPage, java.lang.String propertyName) 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) Returns if a property is a MSM reserved property
void	rollout(ResourceResolver resolver, LiveRelationship relation, boolean reset) Rollout the content for one relation ship.
void	rollout(ResourceResolver resolver, LiveRelationship relation, boolean reset, boolean autoSave) Rollout the content for one relation ship.
void	rollout(RolloutManager.RolloutParams params) Execute a rollout on all live copies of the main page.
void	updateRolloutInfo(Node node, boolean deepUpdate, boolean autoSave) Update rollout info on the node.

Method Detail

rollout

void rollout(RolloutManager.RolloutParams params)
      throws WCMException

Execute a rollout on all live copies of the main page.

Parameters:

params - combined rollout parameters

Throws:

WCMException - when rollout fails

rollout

void rollout(ResourceResolver resolver,
             LiveRelationship relation,
             boolean reset)
      throws WCMException

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.

rollout

void rollout(ResourceResolver resolver,
             LiveRelationship relation,
             boolean reset,
             boolean autoSave)
      throws WCMException

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

autoSave - if true session is saved once the rollout is finished

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

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)

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)

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)

Returns true if a NodeType is configured as excluded in the RolloutManager configuration

Parameters:

nodeType - name of the Repository NodeType.

Returns:

true if excluded.

isExcludedNode

boolean isExcludedNode(Node node)
                throws RepositoryException

If true the given Node will not take part in a roll out.
If one of the Node's PrimaryNodeType or one of its mixin NodeTypes is excluded, this method must return true.
Implementations can extend rules to exclude Nodes from Inheritance for example to exclude protected Nodes

Parameters:

node - Node to check.

Returns:

true if excluded

Throws:

RepositoryException - if an read/write error during this operation occurs.

See Also:

isExcludedNodeType(String)

isReservedProperty

boolean isReservedProperty(java.lang.String propertyName)

Returns if a property is a MSM reserved property

Parameters:

propertyName - repository property name.

Returns:

true if reserved. False otherwise.