com.day.cq.wcm.msm.commons

Class BaseAction

java.lang.Object

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

Direct Known Subclasses:

FilteredAction

public abstract class BaseAction
extends java.lang.Object

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 and 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.
java.lang.String	getName() The name of this action.
java.lang.String	getParameterName() Deprecated.
java.lang.String[]	getPropertiesNames() Deprecated.
int	getRank() Deprecated.
java.lang.String	getTitle() Deprecated.
static boolean	isPage(Node node) Checks if the given Node is considered a Page The check considers the and its primary child the 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 Detail

getName

public java.lang.String getName()

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

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.

Throws:

WCMException

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 and its primary child the Node as being a Page. This is as the com.day.cq.wcm.msm.api.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 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 or it is the Page's Node

Throws:

RepositoryException - on errors accessing the Repository

execute

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

Deprecated.

Throws:

WCMException

execute

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

Deprecated.

Throws:

WCMException

getParameterName

@Deprecated
public java.lang.String getParameterName()

Deprecated.

getRank

@Deprecated
public int getRank()

Deprecated.

getTitle

@Deprecated
public java.lang.String getTitle()

Deprecated.

getPropertiesNames

@Deprecated
public java.lang.String[] getPropertiesNames()

Deprecated.

write

@Deprecated
public void write(JSONWriter jsonWriter)
                       throws JSONException

Deprecated.

Throws:

JSONException