com.dpslink.flash.servlet

Class ClientRequest

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.flash.servlet.ClientRequest

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ClientRequest
extends javax.servlet.http.HttpServlet

Handles AJAX requests from clients.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClientRequest.Context Inner class used to store servlet context information.
class	ClientRequest.DisplayableAttribute Inner class used to define a displayable product attribute.
class	ClientRequest.OrderLine Inner class used to define the data for an uploaded order line.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE_JSON
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
ClientRequest()

Method Summary

Modifier and Type	Method and Description
protected void	createCart(ClientRequest.Context ctx, java.util.ArrayList<ClientRequest.OrderLine> orderLines, org.json.JSONArray rejects) Create the cart and cartlines in the database.
protected ClientRequest.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP GET requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP POST requests.
protected void	dumpParms(javax.servlet.http.HttpServletRequest request) Dump servlet parameters to system.out for testing/debugging.
protected void	errorResult(org.json.JSONObject results, java.lang.String errName) Sets an error result status and error message.
protected void	errorResult(org.json.JSONObject results, java.lang.String errName, java.lang.String value) Sets an error result status and error message.
protected void	findProduct(ClientRequest.Context ctx, org.json.JSONObject results) Find a product based on given criteria.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx) Returns the message text for a given message id suffix.
protected java.lang.String	getTemplateMessage(java.lang.String msgidsfx, java.lang.String value) Returns the message text for a given message id suffix with the given substitution values inserted into the message text.
protected void	logon(ClientRequest.Context ctx, org.json.JSONObject results) Find a product based on given criteria.
protected void	missingParm(org.json.JSONObject results, java.lang.String parmName) Sets up a missing parameter error message in the return object.
protected void	processRequest(ClientRequest.Context ctx, org.json.JSONObject results) Process the client client request.
protected void	setTemplateProductAttributes(ClientRequest.Context ctx) Retrieve and set the product attributes data required by the html template.
protected void	uploadCart(ClientRequest.Context ctx, org.json.JSONObject results) Upload a cart from remote client.
protected void	writeResponse(ClientRequest.Context ctx, javax.servlet.http.HttpServletResponse response, org.json.JSONObject results) Writes a JSON formatted response to the http response output stream for the given set of search result data.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

CONTENT_TYPE_JSON

public static java.lang.String CONTENT_TYPE_JSON

Constructor Detail

ClientRequest

public ClientRequest()

Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

Handles HTTP GET requests. Invoked by the servlet API.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException

Handles HTTP POST requests. Invoked by the servlet API.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

processRequest

protected void processRequest(ClientRequest.Context ctx,
                              org.json.JSONObject results)

Process the client client request.

Parameters:

ctx - (Context) The current servlet context.

results - (JSONObject) The result data.

logon

protected void logon(ClientRequest.Context ctx,
                     org.json.JSONObject results)

Find a product based on given criteria.

Parameters:

ctx - (Context) The servlet's current context.

results - (JSONObject) The result data to populate.

missingParm

protected void missingParm(org.json.JSONObject results,
                           java.lang.String parmName)

Sets up a missing parameter error message in the return object.

Parameters:

results - (JSONObject) The result data to populate.

parmName - (String) The name of the missing parameter.

findProduct

protected void findProduct(ClientRequest.Context ctx,
                           org.json.JSONObject results)

Find a product based on given criteria.

Parameters:

ctx - (Context) The servlet's current context.

results - (JSONObject) The result data to populate.

uploadCart

protected void uploadCart(ClientRequest.Context ctx,
                          org.json.JSONObject results)

Upload a cart from remote client.

Parameters:

ctx - (Context) The servlet's current context.

results - (JSONObject) The result data to populate.

createCart

protected void createCart(ClientRequest.Context ctx,
                          java.util.ArrayList<ClientRequest.OrderLine> orderLines,
                          org.json.JSONArray rejects)

Create the cart and cartlines in the database.

Parameters:

ctx - (Context) The servlet's current context.

setTemplateProductAttributes

protected void setTemplateProductAttributes(ClientRequest.Context ctx)

Retrieve and set the product attributes data required by the html template.

Parameters:

ctx - (Context) The servlet's current context.

dumpParms

protected void dumpParms(javax.servlet.http.HttpServletRequest request)

Dump servlet parameters to system.out for testing/debugging.

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

errorResult

protected void errorResult(org.json.JSONObject results,
                           java.lang.String errName)

Sets an error result status and error message.

Parameters:

results - (JSONObject) The result data to populate.

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

errorResult

protected void errorResult(org.json.JSONObject results,
                           java.lang.String errName,
                           java.lang.String value)

Sets an error result status and error message.

Parameters:

results - (JSONObject) The result data to populate.

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

value - (String) The value that is to be substituted into the message text.

writeResponse

protected void writeResponse(ClientRequest.Context ctx,
                             javax.servlet.http.HttpServletResponse response,
                             org.json.JSONObject results)

Writes a JSON formatted response to the http response output stream for the given set of search result data.

Parameters:

ctx - (Context) The servlet's current context.

response - (HttpServletResponse) The servlet's outgoing response.

results - (JSONObject) The result data to format and write.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx)

Returns the message text for a given message id suffix. Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

getTemplateMessage

protected java.lang.String getTemplateMessage(java.lang.String msgidsfx,
                                              java.lang.String value)

Returns the message text for a given message id suffix with the given substitution values inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgidsfx - (String) The resource key suffix for the message to retrieve. The supplied value is automatically prefixed with "MSG." plus the invoking servlet's class name.

value - (String) The value that is to be substituted into the message text.

Returns:

String - The message text. Any log level value (DEBUG, INFO, WARN, etc.) is stripped from the configured message text and not returned.

createContext

protected ClientRequest.Context createContext(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Invoked by doPost method.

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Returns:

Context - The servlet context.