Package com.day.cq.wcm.msm.commons

Class BaseAction

java.lang.Object

com.day.cq.wcm.msm.commons.BaseAction

All Implemented Interfaces:

JSONItem, LiveAction

Direct Known Subclasses:

FilteredAction

public abstract class BaseAction
extends Object
implements LiveAction

Base implementation for the LiveAction interface. This abstract class offers some basic configuration tasks for building a LiveAction and also default implementations for the deprecated methods. It will speed up the implementation of a LiveAction by only implementing the handles and doExecute abstract methods.

Method Summary

Modifier and Type	Method	Description
void	execute(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave)	Deprecated.
void	execute(ResourceResolver resolver, LiveRelationship relation, ActionConfig config, boolean autoSave, boolean isResetRollout)	Deprecated.
void	execute(Resource source, Resource target, LiveRelationship relation, boolean autoSave, boolean isResetRollout)	Executes the current action. - checks the preconditions using handles() - if preconditions are met the doExecute() is called - changes will be saved automatically if the autoSave flag is set to true This method needs that at least one of the Resource parameters (source,target) to be non-null when used in conjunction with the autoSave flag since a ResourceResolver will need to be obtained to save the changes.
String	getName()	The name of this action.
String	getParameterName()	Deprecated.
String[]	getPropertiesNames()	Deprecated.
int	getRank()	Deprecated.
String	getTitle()	Deprecated.
static boolean	isPage(Node node)	Checks if the given Node is considered a Page The check considers the "cq:Page" and its primary child the "jcr:content" Node as being a Page.
static boolean	resourceHasNode(Resource resource)	Simple test if a Resource exists and is adaptable to Node
void	write(JSONWriter jsonWriter)	Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

The name of this action. It must match the createsAction() from LiveActionFactory that creates this action

Specified by:

getName in interface LiveAction

Returns:

action name

execute

public void execute(Resource source,
 Resource target,
 LiveRelationship relation,
 boolean autoSave,
 boolean isResetRollout)
             throws WCMException

Executes the current action.
- checks the preconditions using handles()
- if preconditions are met the doExecute() is called
- changes will be saved automatically if the autoSave flag is set to true

This method needs that at least one of the Resource parameters (source,target) to be non-null when used in conjunction with the autoSave flag since a ResourceResolver will need to be obtained to save the changes. A NonExistingResource should be used when dealing with non existing resources.

Specified by:

execute in interface LiveAction

Parameters:

source - The Resource to roll-out. This may bee null

target - The Resource to receive modification. This may bee null

relation - LiveRelationship between the two given Resources

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - if an error occurs

See Also:

• RolloutManager.rollout(com.day.cq.wcm.msm.api.RolloutManager.RolloutParams)

resourceHasNode

public static boolean resourceHasNode(Resource resource)

Simple test if a Resource exists and is adaptable to Node

Parameters:

resource - in question

Returns:

true if the Resource is non-synthetic and can be adapted to a Node

isPage

public static boolean isPage(Node node)
                      throws RepositoryException

Checks if the given Node is considered a Page
The check considers the "cq:Page" and its primary child the "jcr:content" Node as being a Page. This is as the RolloutManager calls the LiveActions with the later. As modifications should only be written to its content. Pages should not be changed.

Pages are considered an aggregate of all the Nodes and sub-graph at its "jcr:content" Node. Thus Services may require special treatment of them. Eg. Replication, Revisions are bound to Pages.

Parameters:

node - to Test

Returns:

true if the Node's NodeType is of "cq:Page" or it is the Page's "jcr:content" Node

Throws:

RepositoryException - on errors accessing the Repository

execute

@Deprecated
public void execute(ResourceResolver resolver,
 LiveRelationship relation,
 ActionConfig config,
 boolean autoSave)
             throws WCMException

Deprecated.

Description copied from interface: LiveAction

Executes action. Is called by the Rollout Manager.

Specified by:

execute in interface LiveAction

Parameters:

resolver - resource resolver

relation - live relationship concerned by action.

config - action config

autoSave - Save modifications

Throws:

WCMException - if an error occurs

See Also:

• ActionManager.executeAction(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean)

execute

@Deprecated
public void execute(ResourceResolver resolver,
 LiveRelationship relation,
 ActionConfig config,
 boolean autoSave,
 boolean isResetRollout)
             throws WCMException

Deprecated.

Description copied from interface: LiveAction

Executes action. Is called by the Rollout Manager.

Specified by:

execute in interface LiveAction

Parameters:

resolver - resource resolver

relation - live relationship concerned by action.

config - action config

autoSave - Save modifications

isResetRollout - True if rollout is run in reset mode

Throws:

WCMException - if an error occurs

See Also:

• ActionManager.executeAction(org.apache.sling.api.resource.ResourceResolver, LiveRelationship, ActionConfig, boolean, boolean)

getParameterName

@Deprecated
public String getParameterName()

Deprecated.

Description copied from interface: LiveAction

Returns the global parameter name of current action. Parameter name is used in requests.

Specified by:

getParameterName in interface LiveAction

Returns:

action parameter name

getRank

@Deprecated
public int getRank()

Deprecated.

Description copied from interface: LiveAction

Returns execution rank of the action: actions are executed by ascending ranks

Specified by:

getRank in interface LiveAction

Returns:

action rank

getTitle

@Deprecated
public String getTitle()

Deprecated.

Description copied from interface: LiveAction

Returns the title of current action. Title is used to be displayed to end-user.

Specified by:

getTitle in interface LiveAction

Returns:

action name

getPropertiesNames

@Deprecated
public String[] getPropertiesNames()

Deprecated.

Description copied from interface: LiveAction

Returns names of the properties defined for this action.

Specified by:

getPropertiesNames in interface LiveAction

Returns:

array of parameters names

write

@Deprecated
public void write(JSONWriter jsonWriter)
           throws JSONException

Deprecated.

Description copied from interface: JSONItem

Serializes this descriptor to json

Specified by:

write in interface JSONItem

Specified by:

write in interface LiveAction

Parameters:

jsonWriter - json writer

Throws:

JSONException - if a JSON error occurs