org.jahia.bin

Class JahiaControllerUtils

java.lang.Object

org.jahia.bin.JahiaControllerUtils

public final class JahiaControllerUtils
extends Object

Utility class for Jahia specific action controllers.

Author:

Sergiy Shyrkov

Method Summary

Modifier and Type	Method and Description
static void	checkUserAuthorized(JahiaUser user, String permissions)
static void	checkUserAuthorized(JCRNodeWrapper node, JahiaUser user, String permissions)
static void	checkUserLoggedIn(JahiaUser user)
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.
static int	getIntParameter(javax.servlet.http.HttpServletRequest request, String name, int defaultValue) Retrieves the integer value of the specified request parameter.
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.
static String	getParameter(javax.servlet.http.HttpServletRequest request, String name, String defaultValue) Retrieves the value of the specified request parameter.
static boolean	hasRequiredPermission(JahiaUser user, String permissions)
static boolean	hasRequiredPermission(JCRNodeWrapper node, JahiaUser user, String permissions)

Methods inherited from class java.lang.Object

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

Method Detail

checkUserAuthorized

public static void checkUserAuthorized(JahiaUser user,
                                       String permissions)
                                throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

checkUserAuthorized

public static void checkUserAuthorized(JCRNodeWrapper node,
                                       JahiaUser user,
                                       String permissions)
                                throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

checkUserLoggedIn

public static void checkUserLoggedIn(JahiaUser user)
                              throws JahiaForbiddenAccessException

Throws:

JahiaForbiddenAccessException

getIntParameter

public 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

public 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

public 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

public 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

hasRequiredPermission

public static boolean hasRequiredPermission(JahiaUser user,
                                            String permissions)
                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

hasRequiredPermission

public static boolean hasRequiredPermission(JCRNodeWrapper node,
                                            JahiaUser user,
                                            String permissions)
                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException