org.visallo.web

Class MinimalRequestHandler

java.lang.Object

org.visallo.web.MinimalRequestHandler

All Implemented Interfaces:

com.v5analytics.webster.Handler, com.v5analytics.webster.RequestResponseHandler

public abstract class MinimalRequestHandler
extends Object
implements com.v5analytics.webster.RequestResponseHandler

This is a handler that provides common helper methods, and only depends on Configuration to be injected.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MinimalRequestHandler(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
protected String	getAttributeString(javax.servlet.http.HttpServletRequest request, String name)
protected ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest request)
protected Configuration	getConfiguration()
protected Locale	getLocale(javax.servlet.http.HttpServletRequest request)
protected String	getOptionalParameter(javax.servlet.http.HttpServletRequest request, String parameterName) Attempts to extract the specified parameter from the provided request, if available
protected String[]	getOptionalParameterArray(javax.servlet.http.HttpServletRequest request, String parameterName)
protected String[]	getOptionalParameterAsStringArray(javax.servlet.http.HttpServletRequest request, String parameterName)
protected boolean	getOptionalParameterBoolean(javax.servlet.http.HttpServletRequest request, String parameterName, boolean defaultValue)
protected Boolean	getOptionalParameterBoolean(javax.servlet.http.HttpServletRequest request, String parameterName, Boolean defaultValue)
protected Double	getOptionalParameterDouble(javax.servlet.http.HttpServletRequest request, String parameterName, Double defaultValue)
protected EnumSet<org.vertexium.FetchHint>	getOptionalParameterFetchHints(javax.servlet.http.HttpServletRequest request, String parameterName, EnumSet<org.vertexium.FetchHint> defaultFetchHints)
protected Float	getOptionalParameterFloat(javax.servlet.http.HttpServletRequest request, String parameterName, Float defaultValue)
protected Integer	getOptionalParameterInt(javax.servlet.http.HttpServletRequest request, String parameterName, Integer defaultValue)
protected Long	getOptionalParameterLong(javax.servlet.http.HttpServletRequest request, String parameterName, long defaultValue)
protected Long	getOptionalParameterLong(javax.servlet.http.HttpServletRequest request, String parameterName, Long defaultValue)
protected String[]	getParameterValues(javax.servlet.http.HttpServletRequest request, String parameterName, boolean optional)
protected String	getRequiredParameter(javax.servlet.http.HttpServletRequest request, String parameterName) Attempts to extract the specified parameter from the provided request
protected String[]	getRequiredParameterArray(javax.servlet.http.HttpServletRequest request, String parameterName)
protected double	getRequiredParameterAsDouble(javax.servlet.http.HttpServletRequest request, String parameterName) Attempts to extract the specified parameter from the provided request and convert it to a double value
protected int	getRequiredParameterAsInt(javax.servlet.http.HttpServletRequest request, String parameterName) Attempts to extract the specified parameter from the provided request and convert it to a int value
protected long	getRequiredParameterAsLong(javax.servlet.http.HttpServletRequest request, String parameterName) Attempts to extract the specified parameter from the provided request and convert it to a long value
protected String	getString(javax.servlet.http.HttpServletRequest request, String key)
protected WebApp	getWebApp(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.v5analytics.webster.RequestResponseHandler

handle

Constructor Detail

MinimalRequestHandler

protected MinimalRequestHandler(Configuration configuration)

Method Detail

getConfiguration

protected Configuration getConfiguration()

getWebApp

protected WebApp getWebApp(javax.servlet.http.HttpServletRequest request)

getLocale

protected Locale getLocale(javax.servlet.http.HttpServletRequest request)

getBundle

protected ResourceBundle getBundle(javax.servlet.http.HttpServletRequest request)

getString

protected String getString(javax.servlet.http.HttpServletRequest request,
                           String key)

getRequiredParameter

protected String getRequiredParameter(javax.servlet.http.HttpServletRequest request,
                                      String parameterName)

Attempts to extract the specified parameter from the provided request

Parameters:

request - The request instance containing the parameter

parameterName - The name of the parameter to extract

Returns:

The value of the specified parameter

Throws:

RuntimeException - Thrown if the required parameter was not in the request

getOptionalParameterArray

protected String[] getOptionalParameterArray(javax.servlet.http.HttpServletRequest request,
                                             String parameterName)

getRequiredParameterArray

protected String[] getRequiredParameterArray(javax.servlet.http.HttpServletRequest request,
                                             String parameterName)

getOptionalParameterLong

protected Long getOptionalParameterLong(javax.servlet.http.HttpServletRequest request,
                                        String parameterName,
                                        long defaultValue)

getOptionalParameterLong

protected Long getOptionalParameterLong(javax.servlet.http.HttpServletRequest request,
                                        String parameterName,
                                        Long defaultValue)

getOptionalParameterInt

protected Integer getOptionalParameterInt(javax.servlet.http.HttpServletRequest request,
                                          String parameterName,
                                          Integer defaultValue)

getOptionalParameterFetchHints

protected EnumSet<org.vertexium.FetchHint> getOptionalParameterFetchHints(javax.servlet.http.HttpServletRequest request,
                                                                          String parameterName,
                                                                          EnumSet<org.vertexium.FetchHint> defaultFetchHints)

getOptionalParameterBoolean

protected boolean getOptionalParameterBoolean(javax.servlet.http.HttpServletRequest request,
                                              String parameterName,
                                              boolean defaultValue)

getOptionalParameterBoolean

protected Boolean getOptionalParameterBoolean(javax.servlet.http.HttpServletRequest request,
                                              String parameterName,
                                              Boolean defaultValue)

getOptionalParameterDouble

protected Double getOptionalParameterDouble(javax.servlet.http.HttpServletRequest request,
                                            String parameterName,
                                            Double defaultValue)

getOptionalParameterFloat

protected Float getOptionalParameterFloat(javax.servlet.http.HttpServletRequest request,
                                          String parameterName,
                                          Float defaultValue)

getRequiredParameterAsLong

protected long getRequiredParameterAsLong(javax.servlet.http.HttpServletRequest request,
                                          String parameterName)

Attempts to extract the specified parameter from the provided request and convert it to a long value

Parameters:

request - The request instance containing the parameter

parameterName - The name of the parameter to extract

Returns:

The long value of the specified parameter

Throws:

RuntimeException - Thrown if the required parameter was not in the request

getRequiredParameterAsInt

protected int getRequiredParameterAsInt(javax.servlet.http.HttpServletRequest request,
                                        String parameterName)

Attempts to extract the specified parameter from the provided request and convert it to a int value

Parameters:

request - The request instance containing the parameter

parameterName - The name of the parameter to extract

Returns:

The int value of the specified parameter

Throws:

RuntimeException - Thrown if the required parameter was not in the request

getRequiredParameterAsDouble

protected double getRequiredParameterAsDouble(javax.servlet.http.HttpServletRequest request,
                                              String parameterName)

Attempts to extract the specified parameter from the provided request and convert it to a double value

Parameters:

request - The request instance containing the parameter

parameterName - The name of the parameter to extract

Returns:

The double value of the specified parameter

Throws:

RuntimeException - Thrown if the required parameter was not in the request

getOptionalParameter

protected String getOptionalParameter(javax.servlet.http.HttpServletRequest request,
                                      String parameterName)

Attempts to extract the specified parameter from the provided request, if available

Parameters:

request - The request instance containing the parameter

parameterName - The name of the parameter to extract

Returns:

The value of the specified parameter if found, null otherwise

getOptionalParameterAsStringArray

protected String[] getOptionalParameterAsStringArray(javax.servlet.http.HttpServletRequest request,
                                                     String parameterName)

getParameterValues

protected String[] getParameterValues(javax.servlet.http.HttpServletRequest request,
                                      String parameterName,
                                      boolean optional)

getAttributeString

protected String getAttributeString(javax.servlet.http.HttpServletRequest request,
                                    String name)