org.jahia.bin

Class JahiaMultiActionController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.multiaction.MultiActionController

org.jahia.bin.JahiaMultiActionController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller, org.springframework.web.servlet.mvc.LastModified

Direct Known Subclasses:

CacheController, Notifications, WCAGController

public abstract class JahiaMultiActionController
extends org.springframework.web.servlet.mvc.multiaction.MultiActionController

Base class for Jahia specific action controllers.

Author:

Sergiy Shyrkov

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

DEFAULT_COMMAND_NAME, LAST_MODIFIED_METHOD_SUFFIX, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
JahiaMultiActionController()

Method Summary

Modifier and Type	Method and Description
protected void	checkUserAuthorized()
protected void	checkUserAuthorized(JCRNodeWrapper node)
protected void	checkUserLoggedIn()
protected JahiaUser	getCurrentUser() Returns the current user.
protected static String	getParameter(javax.servlet.http.HttpServletRequest request, String name) Simple utility method to retrieve a parameter from a request and throws an JahiaBadRequestException (results in a 400 error) in case the parameter is not found.
protected static String	getParameter(javax.servlet.http.HttpServletRequest request, String name, String defaultValue) Retrieves the value of the specified request parameter.
protected String	getRequiredPermission() Returns the permission, required to handle this action.
void	setRequiredPermission(String requiredPermission) Sets the permission, required to handle this action.

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

bind, createBinder, getCommandName, getExceptionHandler, getLastModified, getMethodNameResolver, getValidators, getWebBindingInitializer, handleNoSuchRequestHandlingMethod, handleRequestInternal, initBinder, invokeNamedMethod, newCommandObject, setDelegate, setMethodNameResolver, setValidators, setWebBindingInitializer

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaMultiActionController

public JahiaMultiActionController()

Method Detail

getParameter

protected static final String getParameter(javax.servlet.http.HttpServletRequest request,
                                           String name)
                                    throws JahiaBadRequestException

Simple utility method to retrieve a parameter from a request and throws an JahiaBadRequestException (results in a 400 error) in case the parameter is not found.

Parameters:

request - The current HttpServletRequest

name - The parameter name

Returns:

A String containing the value of the given parameter

Throws:

JahiaBadRequestException - in case the parameter is not found in the request

getParameter

protected static final String getParameter(javax.servlet.http.HttpServletRequest request,
                                           String name,
                                           String defaultValue)

Retrieves the value of the specified request parameter. If it does not exist, returns the provided default value.

Parameters:

request - The current HttpServletRequest

name - The parameter name

defaultValue - the default parameter value

Returns:

the value of the specified request parameter. If it does not exist, returns the provided default value

checkUserAuthorized

protected void checkUserAuthorized()
                            throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

checkUserAuthorized

protected void checkUserAuthorized(JCRNodeWrapper node)
                            throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

checkUserLoggedIn

protected void checkUserLoggedIn()
                          throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

getCurrentUser

protected JahiaUser getCurrentUser()

Returns the current user.

Returns:

current user

getRequiredPermission

protected String getRequiredPermission()

Returns the permission, required to handle this action. null if no particular permission is required.

Returns:

the permission, required to handle this action. null if no particular permission is required

setRequiredPermission

public void setRequiredPermission(String requiredPermission)

Sets the permission, required to handle this action. null if no particular permission is required.

Parameters:

requiredPermission - the permission, required to handle this action. null if no particular permission is required