com.purplehillsbooks.web

Class WebRequest

java.lang.Object

com.purplehillsbooks.web.WebRequest

public class WebRequest
extends java.lang.Object

WebRequest provides a lot of convenience functions for handling web requests especially when they are JSON objects being sent back and forth. The posted JSON object is provided in JSONObject form, and WebRequest can easily send JSONObjects as well. Most important thing to learn is the path parser. Given a path like this http://server/app/p1/p2/p3/obj.json This will be parsed into separate tokens, starting with p1 (assuming this is the first path element beyond where the servlet is mounted). Each token can be consumed one at a time with #consumePathToken() This is intended for a recursive descent style parser which has a method for p1, which consumes p2 and calls the method for p2 and so on. This parser properly handles the accidental double slash character and it decodes the path elements.

Field Summary

Fields

Modifier and Type	Field and Description
java.io.OutputStream	outStream
HttpServletRequest	request
java.lang.String	requestURL
HttpServletResponse	response
HttpSession	session
java.io.Writer	w

Constructor Summary

Constructors

Constructor and Description
WebRequest(HttpServletRequest _req, HttpServletResponse _resp)
WebRequest(HttpServletRequest _req, HttpServletResponse _resp, java.io.Writer aw) This constructor is used within a JSP file where the Writer has already been grabbed from the Response object which only allows the writer to be gotten once.

Method Summary

Modifier and Type	Method and Description
java.lang.String	appBaseUrl() This is the base URL for the application, which means it has the protocol, server, port, and application name in the path.
java.lang.String	consumePathToken()
static WebRequest	findOrCreate(HttpServletRequest _req, HttpServletResponse _resp, java.io.Writer aw) This factory method is used within a JSP file where the Writer has already been grabbed from the Response object which only allows the writer to be gotten once.
java.lang.String	getAuthUserId() During the course of this session, if setAuthUserId has been called, then this will return the value that was given at that time.
java.lang.String	getConfigSetting(java.lang.String name)
JSONObject	getPostedObject()
java.lang.String	getSessionProperty(java.lang.String propName)
boolean	isDelete()
boolean	isGet()
boolean	isOptions()
boolean	isPost()
boolean	isPut()
boolean	pathFinished()
void	setAuthUserId(java.lang.String newId) You can implement your own login methods and this simply records the result in the current session.
void	setSessionProperty(java.lang.String propName, java.lang.String newVal)
void	storeContentsToFile(java.io.File destination) Reads the uploaded PUT body, and stores it to the specified file (using a temp name, and deleting whatever file might have been there before.)
void	streamAttachment(java.lang.String attachmentName, java.io.InputStream content)
static void	streamException(java.lang.Throwable e, HttpServletRequest request, HttpServletResponse response, java.io.Writer w)
void	streamException(java.lang.Throwable e, SessionManager score)
void	streamFile(java.io.File fullPath)
void	streamJSON(JSONObject jo)

Methods inherited from class java.lang.Object

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

Field Detail

request

public HttpServletRequest request

response

public HttpServletResponse response

session

public HttpSession session

w

public java.io.Writer w

outStream

public java.io.OutputStream outStream

requestURL

public java.lang.String requestURL

Constructor Detail

WebRequest

public WebRequest(HttpServletRequest _req,
                  HttpServletResponse _resp)
           throws java.lang.Exception

Throws:

java.lang.Exception

WebRequest

public WebRequest(HttpServletRequest _req,
                  HttpServletResponse _resp,
                  java.io.Writer aw)
           throws java.lang.Exception

This constructor is used within a JSP file where the Writer has already been grabbed from the Response object which only allows the writer to be gotten once. Later attempts fail and so this constructor does not attempt to do this. By getting the writer, we do not have access to teh outputstream. There are a couple methods that require the output stream and will not work when constructed from this constructor.

Throws:

java.lang.Exception

Method Detail

findOrCreate

public static WebRequest findOrCreate(HttpServletRequest _req,
                                      HttpServletResponse _resp,
                                      java.io.Writer aw)
                               throws java.lang.Exception

This factory method is used within a JSP file where the Writer has already been grabbed from the Response object which only allows the writer to be gotten once. Later attempts fail and so this factory method does not attempt to do this. By getting the writer, we do not have access to teh outputstream. There are a couple methods that require the output stream and will not work when constructed from this constructor.

Throws:

java.lang.Exception

appBaseUrl

public java.lang.String appBaseUrl()

This is the base URL for the application, which means it has the protocol, server, port, and application name in the path. Everything up to the root of where the application is.

consumePathToken

public java.lang.String consumePathToken()

pathFinished

public boolean pathFinished()

isGet

public boolean isGet()

isPost

public boolean isPost()

isPut

public boolean isPut()

isDelete

public boolean isDelete()

isOptions

public boolean isOptions()

getPostedObject

public JSONObject getPostedObject()
                           throws java.lang.Exception

Throws:

java.lang.Exception

storeContentsToFile

public void storeContentsToFile(java.io.File destination)
                         throws java.lang.Exception

Reads the uploaded PUT body, and stores it to the specified file (using a temp name, and deleting whatever file might have been there before.)

Throws:

java.lang.Exception

streamJSON

public void streamJSON(JSONObject jo)
                throws java.lang.Exception

Throws:

java.lang.Exception

streamException

public void streamException(java.lang.Throwable e,
                            SessionManager score)

streamException

public static void streamException(java.lang.Throwable e,
                                   HttpServletRequest request,
                                   HttpServletResponse response,
                                   java.io.Writer w)

streamFile

public void streamFile(java.io.File fullPath)
                throws java.lang.Exception

Throws:

java.lang.Exception

streamAttachment

public void streamAttachment(java.lang.String attachmentName,
                             java.io.InputStream content)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getAuthUserId

public java.lang.String getAuthUserId()

During the course of this session, if setAuthUserId has been called, then this will return the value that was given at that time. You can implement your own login methods and this simply records the result in the current session. Returns null if not authenticated.

setAuthUserId

public void setAuthUserId(java.lang.String newId)

You can implement your own login methods and this simply records the result in the current session. During the course of this session, if this has been called, then getAuthUserId will return the value that was given at that time. Log a person OUT by setting this to null.

getSessionProperty

public java.lang.String getSessionProperty(java.lang.String propName)

setSessionProperty

public void setSessionProperty(java.lang.String propName,
                               java.lang.String newVal)

getConfigSetting

public java.lang.String getConfigSetting(java.lang.String name)
                                  throws java.lang.Exception

Throws:

java.lang.Exception