com.groiss.servlet

Class HttpUtils

java.lang.Object

com.groiss.servlet.HttpUtils

public class HttpUtils
extends Object

Utility class for dealing with special cases in the area of the HTTP protocol.

Method Summary

Modifier and Type	Method and Description
static String	cookieName(String suffix) Generate a cookie name by prepending the serverid and _ to the suffix.
static String	extractIP(String result)
static Cookie	getCookie(HttpServletRequest req, String suffix) return the cookie from the request.
static String	getCookieValue(HttpServletRequest req, String suffix) Returns a cookie value.
static String	getRemoteAddress(HttpServletRequest req) Returns the "real" remote address of a HttpServletRequest.
static StringBuilder	getRequestURLContext(HttpServletRequest req)
static Cookie	newCookie(String suffix, String value) Generate a new Cookie.
static Cookie	newHttpOnlyCookie(String suffix, String value) Generate a new HTTP-only Cookie.
static void	setCookieSecurity(Cookie c, HttpServletRequest req) Set the security attribute of a cookie.
static void	setNoCache(HttpServletResponse res) Deprecated. Use ServletUtils.setNoCache(HttpServletResponse) instead.

Methods inherited from class java.lang.Object

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

Method Detail

setNoCache

@Deprecated
public static void setNoCache(HttpServletResponse res)

Deprecated. Use ServletUtils.setNoCache(HttpServletResponse) instead.

Set response to no-cache. Note that you have to call this method before data is written (getWriter() or getOutputStream() is called).

Parameters:

res - the HTTP-response

cookieName

public static String cookieName(String suffix)

Generate a cookie name by prepending the serverid and _ to the suffix.

Parameters:

suffix -

Returns:

<serverid>_<suffix>

newCookie

public static Cookie newCookie(String suffix,
                               String value)

Generate a new Cookie. The cookie name is generated from the suffix via cookieName(String).

the Path is set to the servlet context path and the maxAge to -1.

Please be sure to set httpOnly for the cookie via Cookie.setHttpOnly(boolean) if appropriate, or use newHttpOnlyCookie(String, String) directly.

Parameters:

suffix - the suffix of the cookie name

value - the cookie value

Returns:

newHttpOnlyCookie

public static Cookie newHttpOnlyCookie(String suffix,
                                       String value)

Generate a new HTTP-only Cookie. The cookie name is generated from the suffix via cookieName(String).

Parameters:

suffix - the suffix of the cookie name

value - the cookie value

Returns:

setCookieSecurity

public static void setCookieSecurity(Cookie c,
                                     HttpServletRequest req)

Set the security attribute of a cookie. Depends on the configuration property "httpd.jetty.cookie.secure".

• if it is "false": the security attribute of the cookie is unchanged.
• if it is "true"; the security attribute of the cokkie is set to true, if req.isSecure() is true.
• if it is "force", then the security attribute of the cookie is set to "true", irrespective of the security status of the request (useful if there is a SSL-terminating reverse proxy).

Parameters:

c - the cookie for which to set the security attribute.

req - the request

getCookie

public static Cookie getCookie(HttpServletRequest req,
                               String suffix)

return the cookie from the request.

Parameters:

req -

suffix - the name part of the cookie that follows the server id.

Returns:

the cookie or null if no such cookie

getCookieValue

public static String getCookieValue(HttpServletRequest req,
                                    String suffix)

Returns a cookie value.

Parameters:

req -

suffix - the name part of the cookie that follows the server id.

Returns:

the cookie value or null if no such cookie.

getRemoteAddress

public static String getRemoteAddress(HttpServletRequest req)

Returns the "real" remote address of a HttpServletRequest.

Parameters:

req -

Returns:

the leftmost component of the X-Forwarded-For header field, if it exists, req.getRemoteAddr() if not.

extractIP

public static String extractIP(String result)

getRequestURLContext

public static StringBuilder getRequestURLContext(HttpServletRequest req)