org.rhq.enterprise.gui.common.servlet
Class ParameterizedServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.rhq.enterprise.gui.common.servlet.ParameterizedServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

ImageServlet

public abstract class ParameterizedServlet
extends javax.servlet.http.HttpServlet

This class contains some utility methods for parsing parameters.

See Also:

Serialized Form

Constructor Summary

ParameterizedServlet()

Method Summary

protected IllegalArgumentException	invalidParamErr(String paramName, String param) Return an IllegalArgumentException for an invalid parameter.
protected IllegalArgumentException	invalidParamErr(String paramName, String param, List<String> optionList) Return an IllegalArgumentException for an invalid parameter.
protected void	invalidParamWarn(String paramName, String param, double value) Log a warning about an invalid parameter.
protected void	invalidParamWarn(String paramName, String param, int value) Log a warning about an invalid parameter.
protected void	invalidParamWarn(String paramName, String param, long value) Log a warning about an invalid parameter.
protected void	invalidParamWarn(String paramName, String param, String value) Log a warning about an invalid parameter.
protected void	invalidParamWarn(String paramName, String param, String value, List<String> optionList) Log a warning about an invalid parameter.
protected boolean	parseBooleanParameter(javax.servlet.http.HttpServletRequest request, String paramName, boolean defaultValue) Parse a boolean parameter.
protected double	parseDoubleParameter(javax.servlet.http.HttpServletRequest request, String paramName, double defaultValue) Parse a double parameter.
protected <E extends Enum<E>> E	parseEnumParameter(javax.servlet.http.HttpServletRequest request, String parameterName, Class<E> clazz, E defaultValue) Parse the passed parameter to find out its value.
protected int	parseIntParameter(javax.servlet.http.HttpServletRequest request, String paramName, int defaultValue) Parse a int parameter.
protected long	parseLongParameter(javax.servlet.http.HttpServletRequest request, String paramName, long defaultValue) Parse a long parameter.
protected boolean	parseRequiredBooleanParameter(javax.servlet.http.HttpServletRequest request, String paramName) Parse a required boolean parameter.
protected double	parseRequiredDoubleParameter(javax.servlet.http.HttpServletRequest request, String paramName) Parse a required double parameter.
protected int	parseRequiredIntParameter(javax.servlet.http.HttpServletRequest request, String paramName) Parse a required int parameter.
protected long	parseRequiredLongParameter(javax.servlet.http.HttpServletRequest request, String paramName) Parse a required long parameter.
protected String	parseRequiredStringParameter(javax.servlet.http.HttpServletRequest request, String paramName) Parse a required string parameter.
protected String	parseRequiredStringParameter(javax.servlet.http.HttpServletRequest request, String paramName, String[] options) Parse a required string parameter, ensuring that it is equal to one of the passed-in options.
protected String	parseStringParameter(javax.servlet.http.HttpServletRequest request, String paramName, String defaultValue) Parse a string parameter.
protected String	parseStringParameter(javax.servlet.http.HttpServletRequest request, String paramName, String defaultValue, String[] options) Parse a string parameter, ensuring that it is equal to one of the passed-in options.
protected IllegalArgumentException	requiredParamErr(String paramName) Return an IllegalArgumentException for a required parameter.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedServlet

public ParameterizedServlet()

Method Detail

parseBooleanParameter

protected boolean parseBooleanParameter(javax.servlet.http.HttpServletRequest request,
                                        String paramName,
                                        boolean defaultValue)

Parse a boolean parameter.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseRequiredBooleanParameter

protected boolean parseRequiredBooleanParameter(javax.servlet.http.HttpServletRequest request,
                                                String paramName)

Parse a required boolean parameter.

Parameters:

request - the servlet request

paramName - the parameter name

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

parseDoubleParameter

protected double parseDoubleParameter(javax.servlet.http.HttpServletRequest request,
                                      String paramName,
                                      double defaultValue)

Parse a double parameter.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseRequiredDoubleParameter

protected double parseRequiredDoubleParameter(javax.servlet.http.HttpServletRequest request,
                                              String paramName)

Parse a required double parameter.

Parameters:

request - the servlet request

paramName - the parameter name

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

parseIntParameter

protected int parseIntParameter(javax.servlet.http.HttpServletRequest request,
                                String paramName,
                                int defaultValue)

Parse a int parameter.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseRequiredIntParameter

protected int parseRequiredIntParameter(javax.servlet.http.HttpServletRequest request,
                                        String paramName)

Parse a required int parameter.

Parameters:

request - the servlet request

paramName - the parameter name

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

parseLongParameter

protected long parseLongParameter(javax.servlet.http.HttpServletRequest request,
                                  String paramName,
                                  long defaultValue)

Parse a long parameter.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseRequiredLongParameter

protected long parseRequiredLongParameter(javax.servlet.http.HttpServletRequest request,
                                          String paramName)

Parse a required long parameter.

Parameters:

request - the servlet request

paramName - the parameter name

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

parseStringParameter

protected String parseStringParameter(javax.servlet.http.HttpServletRequest request,
                                      String paramName,
                                      String defaultValue)

Parse a string parameter.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseEnumParameter

protected <E extends Enum<E>> E parseEnumParameter(javax.servlet.http.HttpServletRequest request,
                                                   String parameterName,
                                                   Class<E> clazz,
                                                   E defaultValue)

Parse the passed parameter to find out its value. If the parameter is not found, the passed default value will be used

Parameters:

request - A HttpServletRequest

parameterName - The paramter we are looking for

clazz - The class of the desired Enum

defaultValue - A value of the Enum class clazz, which is taken as default

Returns:

either The matched value from the request or the default if it is not found or not valid

Usage example: UnitsConstants x = parseEnumParameter(request, "unitsConstants", UnitsConstants.class, UnitsConstants.UNIT_BITS);

parseStringParameter

protected String parseStringParameter(javax.servlet.http.HttpServletRequest request,
                                      String paramName,
                                      String defaultValue,
                                      String[] options)

Parse a string parameter, ensuring that it is equal to one of the passed-in options.

Parameters:

request - the servlet request

paramName - the name of the parameter to parse

defaultValue - the default value for the parameter

options - the list of valid values for this parameter

Returns:

the value of the parsed parameter or the default if the parameter didn't exist

parseRequiredStringParameter

protected String parseRequiredStringParameter(javax.servlet.http.HttpServletRequest request,
                                              String paramName)

Parse a required string parameter.

Parameters:

request - the servlet request

paramName - the parameter name

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

parseRequiredStringParameter

protected String parseRequiredStringParameter(javax.servlet.http.HttpServletRequest request,
                                              String paramName,
                                              String[] options)

Parse a required string parameter, ensuring that it is equal to one of the passed-in options.

Parameters:

request - the servlet request

paramName - the parameter name

options - the list of valid values for this parameter

Returns:

the value of the parsed parameter

Throws:

IllegalArgumentException - if the parameter didn't exist

requiredParamErr

protected IllegalArgumentException requiredParamErr(String paramName)

Return an IllegalArgumentException for a required parameter.

Parameters:

paramName - the name of the parameter

Returns:

an IllegalArgumentException

invalidParamErr

protected IllegalArgumentException invalidParamErr(String paramName,
                                                   String param)

Return an IllegalArgumentException for an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

Returns:

an IllegalArgumentException

invalidParamErr

protected IllegalArgumentException invalidParamErr(String paramName,
                                                   String param,
                                                   List<String> optionList)

Return an IllegalArgumentException for an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

optionList - the list of valid options for this parameter

Returns:

an IllegalArgumentException

invalidParamWarn

protected void invalidParamWarn(String paramName,
                                String param,
                                double value)

Log a warning about an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

value - the default value

invalidParamWarn

protected void invalidParamWarn(String paramName,
                                String param,
                                int value)

Log a warning about an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

value - the default value

invalidParamWarn

protected void invalidParamWarn(String paramName,
                                String param,
                                long value)

Log a warning about an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

value - the default value

invalidParamWarn

protected void invalidParamWarn(String paramName,
                                String param,
                                String value)

Log a warning about an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

value - the default value

invalidParamWarn

protected void invalidParamWarn(String paramName,
                                String param,
                                String value,
                                List<String> optionList)

Log a warning about an invalid parameter.

Parameters:

paramName - the name of the parameter

param - the value of the parameter

value - the default value

optionList - the list of valid options for this parameter