com.hfg.webapp

Class WebappUtil

java.lang.Object

com.hfg.webapp.WebappUtil

public class WebappUtil
extends Object

Webapp-related static functions.

Constructor Summary

Constructors

Constructor and Description
WebappUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	cookieNeedsEncoding(javax.servlet.http.Cookie inCookie) Trys to determine if the cookie value needs to be encoded according to section 4.1.1 of RFC 6265.
static String	decodeCookieValue(String inEncodedValue) Decodes the cookie value according to section 4.1.1 of RFC 6265.
static void	emitJSON(javax.servlet.http.HttpServletResponse inServletResponse, JsCollection inJSON) Writes the specified JSON to the servlet response after setting the mime type and character encoding.
static void	emitXMLDoc(javax.servlet.http.HttpServletResponse inServletResponse, XMLDoc inXMLDoc) Writes the specified XML file to the servlet response after setting the mime type and character encoding.
static String	encodeCookieValue(String inUnencodedValue) Encodes the cookie value according to section 4.1.1 of RFC 6265.
static boolean	isCookieEncoded(javax.servlet.http.Cookie inCookie) Trys to determine if the cookie value has been encoded according to section 4.1.1 of RFC 6265.
static boolean	isCookieEncoded(String inCookieValue) Trys to determine if the cookie value has been encoded according to section 4.1.1 of RFC 6265.
static void	setupResponseForFileDownload(javax.servlet.http.HttpServletResponse inResponse, MimeType inMimeType, File inFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebappUtil

public WebappUtil()

Method Detail

setupResponseForFileDownload

public static void setupResponseForFileDownload(javax.servlet.http.HttpServletResponse inResponse,
                                                MimeType inMimeType,
                                                File inFile)
                                         throws Exception

Throws:

Exception

encodeCookieValue

public static String encodeCookieValue(String inUnencodedValue)

Encodes the cookie value according to section 4.1.1 of RFC 6265. (See http://www.rfc-editor.org/rfc/rfc6265.txt) Note that the cookie-value is limited to US-ASCII but this implementation will include characters above ASCII without escaping them.

cookieNeedsEncoding

public static boolean cookieNeedsEncoding(javax.servlet.http.Cookie inCookie)

Trys to determine if the cookie value needs to be encoded according to section 4.1.1 of RFC 6265. (See http://www.rfc-editor.org/rfc/rfc6265.txt)

isCookieEncoded

public static boolean isCookieEncoded(javax.servlet.http.Cookie inCookie)

Trys to determine if the cookie value has been encoded according to section 4.1.1 of RFC 6265. (See http://www.rfc-editor.org/rfc/rfc6265.txt)

isCookieEncoded

public static boolean isCookieEncoded(String inCookieValue)

Trys to determine if the cookie value has been encoded according to section 4.1.1 of RFC 6265. (See http://www.rfc-editor.org/rfc/rfc6265.txt)

decodeCookieValue

public static String decodeCookieValue(String inEncodedValue)

Decodes the cookie value according to section 4.1.1 of RFC 6265. (See http://www.rfc-editor.org/rfc/rfc6265.txt)

Parameters:

inEncodedValue - the encoded cookie value to be decoded

Returns:

the decoded cookie value

emitJSON

public static void emitJSON(javax.servlet.http.HttpServletResponse inServletResponse,
                            JsCollection inJSON)
                     throws IOException

Writes the specified JSON to the servlet response after setting the mime type and character encoding.

Parameters:

inServletResponse - the servlet response to which the JSON should be written

inJSON - the JSON to be written to the servlet response

Throws:

IOException

emitXMLDoc

public static void emitXMLDoc(javax.servlet.http.HttpServletResponse inServletResponse,
                              XMLDoc inXMLDoc)
                       throws Exception

Writes the specified XML file to the servlet response after setting the mime type and character encoding.

Parameters:

inServletResponse - the servlet response to which the XML file should be written

inXMLDoc - the XML file to be written to the servlet response

Throws:

Exception