com.paypal.selion.utils

Class ServletHelper

java.lang.Object

com.paypal.selion.utils.ServletHelper

public final class ServletHelper
extends Object

A utility class that basically helps in extracting information from Servlet request/responses also has the commonly load the HTML template from resource and write it to the response.

Constructor Summary

Constructors

Constructor and Description
ServletHelper()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	getParameters(javax.servlet.http.HttpServletRequest request) Helps retrieve the parameters and its values as a Map
static void	respondAsHtmlUsingArgsAndTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp, String resourcePageTemplate, int statusCode, Object... args) Sends a HTTP response as a text/html document and with a HTTP status code.
static void	respondAsHtmlUsingJsonAndTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp, Object response, String resourcePageTemplate, int statusCode) Sends a HTTP response as a text/html document and with a HTTP status code.
static void	respondAsHtmlUsingTemplate(javax.servlet.http.HttpServletResponse resp, String resourcePageTemplate) Sends a HTTP response as a text/html document.
static void	respondAsHtmlUsingTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp, String resourcePageTemplate, int statusCode) Sends a HTTP response as a text/html document and with a HTTP status code.
static void	respondAsHtmlWithMessage(javax.servlet.http.HttpServletResponse resp, String message) Utility method used to display a message when re-direction happens in the UI flow.
static void	respondAsJsonWithHttpStatus(javax.servlet.http.HttpServletResponse resp, Object response, int statusCode) Sends a HTTP response as a application/json document and with a HTTP status code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletHelper

public ServletHelper()

Method Detail

getParameters

public static Map<String,String> getParameters(javax.servlet.http.HttpServletRequest request)

Helps retrieve the parameters and its values as a Map

Parameters:

request - A HttpServletRequest that represents the request from which the parameters and their corresponding values are to be extracted.

Returns:

A Map that represents the parameters and their values

respondAsJsonWithHttpStatus

public static void respondAsJsonWithHttpStatus(javax.servlet.http.HttpServletResponse resp,
                                               Object response,
                                               int statusCode)
                                        throws IOException

Sends a HTTP response as a application/json document and with a HTTP status code.

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

response - The response object which will be serialized to a JSON document

statusCode - The HTTP status code to send with the response

Throws:

IOException

respondAsHtmlUsingJsonAndTemplateWithHttpStatus

public static void respondAsHtmlUsingJsonAndTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp,
                                                                   Object response,
                                                                   String resourcePageTemplate,
                                                                   int statusCode)
                                                            throws IOException

Sends a HTTP response as a text/html document and with a HTTP status code. Injects a json object into the template before responding.

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

response - The response object which will be serialized to a JSON document.

resourcePageTemplate - The HTML template to use which is loaded as a classpath resource.

statusCode - The HTTP status code to send with the response.

Throws:

IOException

respondAsHtmlUsingArgsAndTemplateWithHttpStatus

public static void respondAsHtmlUsingArgsAndTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp,
                                                                   String resourcePageTemplate,
                                                                   int statusCode,
                                                                   Object... args)
                                                            throws IOException

Sends a HTTP response as a text/html document and with a HTTP status code. Injects the the provided arguments into the template before responding.

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

resourcePageTemplate - The HTML template to use which is loaded as a classpath resource.

statusCode - The HTTP status code to send with the response.

args - Data which will be inserted in to the template. Data must be typed in accordance with template expectations -- all args are passed to String.format

Throws:

IOException

respondAsHtmlUsingTemplateWithHttpStatus

public static void respondAsHtmlUsingTemplateWithHttpStatus(javax.servlet.http.HttpServletResponse resp,
                                                            String resourcePageTemplate,
                                                            int statusCode)
                                                     throws IOException

Sends a HTTP response as a text/html document and with a HTTP status code.

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

resourcePageTemplate - The HTML template to use which is loaded as a classpath resource.

statusCode - The HTTP status code to send with the response.

Throws:

IOException

respondAsHtmlUsingTemplate

public static void respondAsHtmlUsingTemplate(javax.servlet.http.HttpServletResponse resp,
                                              String resourcePageTemplate)
                                       throws IOException

Sends a HTTP response as a text/html document. Replies with HTTP status code 200 OK

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

resourcePageTemplate - The HTML template to use which is loaded as a classpath resource.

Throws:

IOException

respondAsHtmlWithMessage

public static void respondAsHtmlWithMessage(javax.servlet.http.HttpServletResponse resp,
                                            String message)
                                     throws IOException

Utility method used to display a message when re-direction happens in the UI flow. Uses the template MESSAGE_RESOURCE_PAGE_FILE

Parameters:

resp - A HttpServletResponse object that the servlet is responding on.

message - Message to display.

Throws:

IOException