org.craftercms.commons.http

Class HttpUtils

java.lang.Object

org.craftercms.commons.http.HttpUtils

public class HttpUtils
extends Object

Utility methods for HTTP related stuff.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HTTP_PORT
static int	DEFAULT_HTTPS_PORT
static String	HTTP_SCHEME
static String	HTTPS_SCHEME

Constructor Summary

Constructors

Constructor and Description
HttpUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static StringBuilder	getBaseRequestUrl(javax.servlet.http.HttpServletRequest request, boolean forceHttps) Returns the portion from the URL that includes the scheme, server name and port number, without the server path.
static javax.servlet.http.Cookie	getCookie(String name, javax.servlet.http.HttpServletRequest request) Returns the cookie with the given name for the given request
static String	getCookieValue(String name, javax.servlet.http.HttpServletRequest request) Returns the cookie value with the given name for the given request
static String	getFullUrl(javax.servlet.http.HttpServletRequest request, String relativeUrl) Returns the full URL for the relative URL based in the specified request.
static String	getRequestUriWithoutContextPath(javax.servlet.http.HttpServletRequest request) Returns the request URI without the context path.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_SCHEME

public static final String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

public static final String HTTPS_SCHEME

See Also:

Constant Field Values

DEFAULT_HTTP_PORT

public static final int DEFAULT_HTTP_PORT

See Also:

Constant Field Values

DEFAULT_HTTPS_PORT

public static final int DEFAULT_HTTPS_PORT

See Also:

Constant Field Values

Constructor Detail

HttpUtils

public HttpUtils()

Method Detail

getBaseRequestUrl

public static StringBuilder getBaseRequestUrl(javax.servlet.http.HttpServletRequest request,
                              boolean forceHttps)

Returns the portion from the URL that includes the scheme, server name and port number, without the server path.

Parameters:

request - the request object used to build the base URL

forceHttps - if HTTPS should be enforced

Returns:

the base request URL

getFullUrl

public static String getFullUrl(javax.servlet.http.HttpServletRequest request,
                String relativeUrl)

Returns the full URL for the relative URL based in the specified request. The full URL includes the scheme, server name, port number, context path and server path.

Parameters:

request - the request object used to build the base URL

relativeUrl - the relative URL

Returns:

the full URL

getRequestUriWithoutContextPath

public static final String getRequestUriWithoutContextPath(javax.servlet.http.HttpServletRequest request)

Returns the request URI without the context path.

Parameters:

request - the request where to get the URI from

getCookie

public static javax.servlet.http.Cookie getCookie(String name,
                                  javax.servlet.http.HttpServletRequest request)

Returns the cookie with the given name for the given request

Parameters:

name - the name of the cookie

request - the request where to extract the request from

Returns:

the cookie object, or null if not found

getCookieValue

public static String getCookieValue(String name,
                    javax.servlet.http.HttpServletRequest request)

Returns the cookie value with the given name for the given request

Parameters:

name - the name of the cookie

request - the request where to extract the request from

Returns:

the cookie value, or null if no cookie found