org.jahia.bin

Class Action

java.lang.Object

org.jahia.bin.Action

Direct Known Subclasses:

BaseTagAction, DefaultDeleteAction, DefaultPostAction, DefaultPutAction, LicensedAction, SystemAction, WebflowAction

public abstract class Action
extends Object

Base handler for content actions.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
protected JCRNodeWrapper	createNode(javax.servlet.http.HttpServletRequest req, Map<String,List<String>> parameters, JCRNodeWrapper node, String nodeType, String nodeName, boolean forceCreation)
abstract ActionResult	doExecute(javax.servlet.http.HttpServletRequest req, RenderContext renderContext, Resource resource, JCRSessionWrapper session, Map<String,List<String>> parameters, URLResolver urlResolver)
protected JahiaUser	getCurrentUser() Returns the current user.
protected org.json.JSONObject	getJSONConstraintError(javax.jcr.nodetype.ConstraintViolationException e)
String	getName()
protected static String	getParameter(Map<String,List<String>> parameters, String paramName) Returns a single value for the specified parameter.
protected static String	getParameter(Map<String,List<String>> parameters, String paramName, String defaultValue) Returns a single value for the specified parameter.
protected static String	getRequiredParameter(Map<String,List<String>> parameters, String paramName) Returns a single value for the specified parameter.
String	getRequiredPermission() Returns a permission, required to execute this action or null if no particular permission is required.
String	getRequiredWorkspace() Returns JCR workspace name this action should be executed for; null if there is no required workspace.
boolean	isPermitted(JCRNodeWrapper node)
boolean	isRequireAuthenticatedUser() Returns true if the action can be executed only by an authenticated user.
void	setName(String name) Sets the action name.
protected void	setProperties(JCRNodeWrapper newNode, Map<String,List<String>> parameters)
void	setRequireAuthenticatedUser(boolean requireAuthenticatedUser) Defines if the action can be executed only by an authenticated user.
void	setRequiredPermission(String requiredPermission) Defines a permission, required to execute this action or null if no particular permission is required.
void	setRequiredWorkspace(String requiredWorkspace) Sets the JCR workspace name this action should be executed for; null if there is no required workspace.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action()

Method Detail

getRequiredParameter

protected static String getRequiredParameter(Map<String,List<String>> parameters,
                                             String paramName)
                                      throws JahiaBadRequestException

Returns a single value for the specified parameter. If the parameter is not present throws the JahiaBadRequestException.

Parameters:

parameters - the map of action parameters

paramName - the name of the parameter in question

Returns:

a single value for the specified parameter. If the parameter is not present throws the JahiaBadRequestException

Throws:

JahiaBadRequestException - if the specified parameter is not present in the request

getParameter

protected static String getParameter(Map<String,List<String>> parameters,
                                     String paramName)

Returns a single value for the specified parameter. If the parameter is not present or its value is empty, returns null.

Parameters:

parameters - the map of action parameters

paramName - the name of the parameter in question

Returns:

a single value for the specified parameter. If the parameter is not present or its value is empty, returns null

getParameter

protected static String getParameter(Map<String,List<String>> parameters,
                                     String paramName,
                                     String defaultValue)

Returns a single value for the specified parameter. If the parameter is not present or its value is empty, returns the provided default value.

Parameters:

parameters - the map of action parameters

paramName - the name of the parameter in question

defaultValue - the default value to be used if the parameter is not present or its value is empty

Returns:

a single value for the specified parameter. If the parameter is not present or its value is empty, returns the provided default value

createNode

protected JCRNodeWrapper createNode(javax.servlet.http.HttpServletRequest req,
                                    Map<String,List<String>> parameters,
                                    JCRNodeWrapper node,
                                    String nodeType,
                                    String nodeName,
                                    boolean forceCreation)
                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setProperties

protected void setProperties(JCRNodeWrapper newNode,
                             Map<String,List<String>> parameters)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getJSONConstraintError

protected org.json.JSONObject getJSONConstraintError(javax.jcr.nodetype.ConstraintViolationException e)
                                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

doExecute

public abstract ActionResult doExecute(javax.servlet.http.HttpServletRequest req,
                                       RenderContext renderContext,
                                       Resource resource,
                                       JCRSessionWrapper session,
                                       Map<String,List<String>> parameters,
                                       URLResolver urlResolver)
                                throws Exception

Throws:

Exception

getCurrentUser

protected JahiaUser getCurrentUser()

Returns the current user.

Returns:

current user

getName

public String getName()

getRequiredPermission

public String getRequiredPermission()

Returns a permission, required to execute this action or null if no particular permission is required.

Returns:

a permission, required to execute this action or null if no particular permission is required

getRequiredWorkspace

public String getRequiredWorkspace()

Returns JCR workspace name this action should be executed for; null if there is no required workspace.

Returns:

JCR workspace name this action should be executed for; null if there is no required workspace.

isPermitted

public boolean isPermitted(JCRNodeWrapper node)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isRequireAuthenticatedUser

public boolean isRequireAuthenticatedUser()

Returns true if the action can be executed only by an authenticated user.

Returns:

true if the action can be executed only by an authenticated user

setName

public void setName(String name)

Sets the action name.

Parameters:

name - the action name

setRequireAuthenticatedUser

public void setRequireAuthenticatedUser(boolean requireAuthenticatedUser)

Defines if the action can be executed only by an authenticated user.

Parameters:

requireAuthenticatedUser - true if the action can be executed only by an authenticated user

setRequiredPermission

public void setRequiredPermission(String requiredPermission)

Defines a permission, required to execute this action or null if no particular permission is required.

Parameters:

requiredPermission - a permission, required to execute this action or null if no particular permission is required

setRequiredWorkspace

public void setRequiredWorkspace(String requiredWorkspace)

Sets the JCR workspace name this action should be executed for; null if there is no required workspace.

Parameters:

requiredWorkspace - the JCR workspace name this action should be executed for; null if there is no required workspace