org.jahia.bin

Class JahiaController

java.lang.Object

org.jahia.bin.JahiaController

All Implemented Interfaces:

org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

BaseFindController, Captcha, DocumentConverter, Export, Initializers, StoreHistory, TextExtractor

public abstract class JahiaController
extends Object
implements org.springframework.web.servlet.mvc.Controller

Base class for Jahia specific action controllers.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
JahiaController()

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 int	getIntParameter(javax.servlet.http.HttpServletRequest request, String name) Simple utility method to retrieve an integer parameter from a request and throws an JahiaBadRequestException (results in a 400 error) in case the parameter is not found.
protected static int	getIntParameter(javax.servlet.http.HttpServletRequest request, String name, int defaultValue) Retrieves the integer value of the specified request parameter.
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.
protected boolean	isRequireAuthenticatedUser()
protected boolean	isUserGuest() Returns true if the current user is a non-authenticated user.
void	setRequireAuthenticatedUser(boolean requireAuthenticatedUser)
void	setRequiredPermission(String requiredPermission) Sets the permission, required to handle this action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.mvc.Controller

handleRequest

Constructor Detail

JahiaController

public JahiaController()

Method Detail

getIntParameter

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

Simple utility method to retrieve an integer 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:

an integer value of the given parameter

Throws:

JahiaBadRequestException - in case the parameter is not found in the request or a parsing exception occurs

getIntParameter

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

Retrieves the integer 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

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

isRequireAuthenticatedUser

protected boolean isRequireAuthenticatedUser()

isUserGuest

protected boolean isUserGuest()

Returns true if the current user is a non-authenticated user.

Returns:

true if the current user is a non-authenticated user

setRequireAuthenticatedUser

public void setRequireAuthenticatedUser(boolean requireAuthenticatedUser)

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