com.day.cq.wcm.api.msm

Interface ActionManager

Deprecated.

since 5.3 use com.day.cq.wcm.msm.api.ActionManager instead

@Deprecated
public interface ActionManager

Provides a service to manage live actions

Method Summary

Modifier and Type	Method and Description
void	executeAction(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave) Deprecated. Execute action defined by config.
void	executeAction(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave, boolean isResetRollout) Deprecated. Execute action defined by config.
void	executeActions(ResourceResolver resolver, LiveRelationship relation, boolean autoSave) Deprecated. Execute actions found in relationship.
void	executeActions(ResourceResolver resolver, LiveRelationship relation, boolean autoSave, boolean isResetRollout) Deprecated. Execute actions found in relationship.
ActionConfig	getActionConfig(Node node, boolean inherited) Deprecated. Returns an ActionConfig object from a resource node.
ActionConfig	getActionConfig(Resource resource, boolean inherited) Deprecated. Returns an ActionConfig object from a resource.
java.util.Set<ActionConfig>	getActionsConfig(Node node, java.lang.String resourceNodeType, java.lang.String actionNodeName, boolean inherited) Deprecated. Returns all ActionConfig objects from a node.
java.util.Set<ActionConfig>	getActionsConfig(Resource resource, java.lang.String resourceNodeType, java.lang.String actionNodeName, boolean inherited) Deprecated. Returns all ActionConfig objects from a resource.
boolean	isActionUpdated(SlingHttpServletRequest request, LiveRelationship relation) Deprecated. Determines if at least one action config defined in relation has been updated in request.
void	registerAcion(LiveAction action) Deprecated. Registers a LiveAction in the ActionManager.
void	unregisterAcion(LiveAction action) Deprecated. Unregisters a LiveAction from the ActionManager.
void	writeConfigFromRequest(SlingHttpServletRequest request, Node actionsNode) Deprecated. Write config from request to a node.

Method Detail

registerAcion

void registerAcion(LiveAction action)

Deprecated.

Registers a LiveAction in the ActionManager. This step is required to enable action is the rollout process.

Parameters:

action - action to regiter

unregisterAcion

void unregisterAcion(LiveAction action)

Deprecated.

Unregisters a LiveAction from the ActionManager.

Parameters:

action - action to unregiter

executeActions

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

Deprecated.

Execute actions found in relationship. Only registered actions will be executed.

Parameters:

resolver - resource resolver

relation - live relationship

autoSave - Save modifications

Throws:

WCMException - occurs if one action is not registered or if action execution throws an exception

See Also:

LiveAction.execute(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

executeActions

void executeActions(ResourceResolver resolver,
                    LiveRelationship relation,
                    boolean autoSave,
                    boolean isResetRollout)
             throws WCMException

Deprecated.

Execute actions found in relationship. Only registered actions will be executed.

Parameters:

resolver - resource resolver

relation - live relationship

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - occurs if one action is not registered or if action execution throws an exception

See Also:

LiveAction.execute(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

executeAction

void executeAction(ResourceResolver resolver,
                   LiveRelationship relation,
                   ActionConfig config,
                   boolean autoSave)
            throws WCMException

Deprecated.

Execute action defined by config. Note that actions found in relationship are not executed. Only a registered action will be executed.

Parameters:

resolver - resource resolver

relation - live relationship

config - defines actions to execute

autoSave - Save modifications

Throws:

WCMException - occurs if one action is not registered or if action execution throws an exception

See Also:

LiveAction.execute(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

executeAction

void executeAction(ResourceResolver resolver,
                   LiveRelationship relation,
                   ActionConfig config,
                   boolean autoSave,
                   boolean isResetRollout)
            throws WCMException

Deprecated.

Execute action defined by config. Note that actions found in relationship are not executed. Only a registered action will be executed.

Parameters:

resolver - resource resolver

relation - live relationship

config - defines actions to execute

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - occurs if one action is not registered or if action execution throws an exception

See Also:

LiveAction.execute(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

getActionConfig

ActionConfig getActionConfig(Resource resource,
                             boolean inherited)
                      throws RepositoryException

Deprecated.

Returns an ActionConfig object from a resource.

Parameters:

resource - base to generate an action config

inherited - Mark action config as inherited

Returns:

constructed ActionConfig, null if construction is not possible

Throws:

RepositoryException - occurs while reading the repository

getActionConfig

ActionConfig getActionConfig(Node node,
                             boolean inherited)
                      throws RepositoryException

Deprecated.

Returns an ActionConfig object from a resource node.

Parameters:

node - base to generate an action config

inherited - Mark action config as inherited

Returns:

constructed ActionConfig, null if construction is not possible

Throws:

RepositoryException - occurs while reading the repository

getActionsConfig

java.util.Set<ActionConfig> getActionsConfig(Resource resource,
                                             java.lang.String resourceNodeType,
                                             java.lang.String actionNodeName,
                                             boolean inherited)
                                      throws RepositoryException

Deprecated.

Returns all ActionConfig objects from a resource. Checks if resource is from resourceNodeType resource type and reads actions under actionNodeName child node.

Parameters:

resource - base to generate an action config

resourceNodeType - node type to check on the resource

actionNodeName - name of node containing actions

inherited - Mark action config as inherited

Returns:

constructed ActionConfig, null if construction is not possible

Throws:

RepositoryException - occurs while reading the repository

getActionsConfig

java.util.Set<ActionConfig> getActionsConfig(Node node,
                                             java.lang.String resourceNodeType,
                                             java.lang.String actionNodeName,
                                             boolean inherited)
                                      throws RepositoryException

Deprecated.

Returns all ActionConfig objects from a node. Checks if node is from resourceNodeType resource type and reads actions under actionNodeName child node.

Parameters:

node - base to generate an action config

resourceNodeType - node type to check on the resource

actionNodeName - name of node containing actions

inherited - Mark action config as inherited

Returns:

constructed ActionConfig, null if construction is not possible

Throws:

RepositoryException - occurs while reading the repository

writeConfigFromRequest

void writeConfigFromRequest(SlingHttpServletRequest request,
                            Node actionsNode)
                     throws WCMException

Deprecated.

Write config from request to a node. Reads action config in request and writes it in action node.

Parameters:

request - the request

actionsNode - the action node to write

Throws:

WCMException - if an error occurs

isActionUpdated

boolean isActionUpdated(SlingHttpServletRequest request,
                        LiveRelationship relation)
                 throws WCMException

Deprecated.

Determines if at least one action config defined in relation has been updated in request.

Parameters:

request - the request

relation - live relationship

Returns:

true if updated, false otherwise

Throws:

WCMException - if an error occurs