com.ecyrd.jspwiki.util
Class HttpUtil

java.lang.Object
  extended by com.ecyrd.jspwiki.util.HttpUtil

public final class HttpUtil
extends Object

Contains useful utilities for some common HTTP tasks.

Since:
2.1.61.

Method Summary
static boolean checkFor304(HttpServletRequest req, WikiPage page)
          If returns true, then should return a 304 (HTTP_NOT_MODIFIED)
static String createETag(WikiPage p)
          Creates an ETag based on page information.
static String guessValidURI(String uri)
          Attempts to form a valid URI based on the string given.
static String retrieveCookieValue(HttpServletRequest request, String cookieName)
          Attempts to retrieve the given cookie value from the request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

retrieveCookieValue

public static String retrieveCookieValue(HttpServletRequest request,
                                         String cookieName)
Attempts to retrieve the given cookie value from the request. Returns the string value (which may or may not be decoded correctly, depending on browser!), or null if the cookie is not found. The algorithm will automatically trim leading and trailing double quotes, if found.

Parameters:
request - The current request
cookieName - The name of the cookie to fetch.
Returns:
Value of the cookie, or null, if there is no such cookie.

createETag

public static String createETag(WikiPage p)
Creates an ETag based on page information. An ETag is unique to each page and version, so it can be used to check if the page has changed. Do not assume that the ETag is in any particular format.

Parameters:
p - The page for which the ETag should be created.
Returns:
A String depiction of an ETag.

checkFor304

public static boolean checkFor304(HttpServletRequest req,
                                  WikiPage page)
If returns true, then should return a 304 (HTTP_NOT_MODIFIED)

Parameters:
req - the HTTP request
page - the wiki page to check for
Returns:
the result of the check

guessValidURI

public static String guessValidURI(String uri)
Attempts to form a valid URI based on the string given. Currently it can guess email addresses (mailto:). If nothing else is given, it assumes it to be a http:// url.

Parameters:
uri - URI to take a poke at
Returns:
Possibly a valid URI
Since:
2.2.8