org.fujion.core

Class RequestUtil

java.lang.Object

org.fujion.core.RequestUtil

public class RequestUtil
extends Object

Utility methods for dealing with servlet requests.

Method Summary

Modifier and Type	Method and Description
static javax.servlet.http.HttpServletRequest	assertRequest() Return request, throwing IllegalStateException if invoked outside the scope of an Execution/ServletRequest
static String	getBaseURL(javax.servlet.http.HttpServletRequest request) Returns the full base URL for the servlet.
static String	getLocalHostAddress() Return local host IP.
static String	getRemoteAddress() Return client's ip address.
static javax.servlet.http.HttpServletRequest	getRequest() Return current HttpServletRequest.
static URL	getResourceURL(javax.servlet.http.HttpServletRequest request) Returns the resolved URL of the servlet request path.
static URL	getResourceURL(String path) Returns the resolved URL for the specified path.
static String	getServerName() Return server name.
static javax.servlet.http.HttpSession	getSession() Return current HttpSession
static javax.servlet.http.HttpSession	getSession(javax.servlet.ServletRequest request) Return current HttpSession given request.
static String	getSessionId() Get current request's session id or null if session has not yet been created or if invoked outside the scope of an Execution/ServletRequest.
static void	logHeaderNames() Logs at trace level the request headers

Methods inherited from class java.lang.Object

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

Method Detail

getRequest

public static javax.servlet.http.HttpServletRequest getRequest()

Return current HttpServletRequest. Note that this will return null when invoked outside the scope of an execution/request.

Returns:

HttpServletRequest, null when invoked outside the scope of an Execution/ServletRequest

See Also:

RequestContextHolder.currentRequestAttributes()

getSession

public static javax.servlet.http.HttpSession getSession()

Return current HttpSession

Returns:

HttpSession, null when invoked outside the scope of a servlet request

getSession

public static javax.servlet.http.HttpSession getSession(javax.servlet.ServletRequest request)

Return current HttpSession given request.

Parameters:

request - Servlet request object.

Returns:

HttpSession or null if none present.

logHeaderNames

public static void logHeaderNames()

Logs at trace level the request headers

getServerName

public static String getServerName()

Return server name.

Returns:

server name

See Also:

ServletRequest.getServerName()

getLocalHostAddress

public static String getLocalHostAddress()

Return local host IP. Note: HttpServletRequest#getLocalAddr() doesn't seem to be consistent. This method uses java.net.InetAddress.

Returns:

server IP

See Also:

InetAddress.getHostAddress()

getRemoteAddress

public static String getRemoteAddress()

Return client's ip address. Returns null if invoked outside scope of a servlet request.

This considers header X-FORWARDED-FOR (i.e. useful if behind a proxy)

Returns:

the client's IP

getBaseURL

public static String getBaseURL(javax.servlet.http.HttpServletRequest request)

Returns the full base URL for the servlet.

Parameters:

request - The servlet request.

Returns:

The full base URL.

getResourceURL

public static URL getResourceURL(javax.servlet.http.HttpServletRequest request)

Returns the resolved URL of the servlet request path.

Parameters:

request - The servlet request.

Returns:

The resolved URL.

getResourceURL

public static URL getResourceURL(String path)

Returns the resolved URL for the specified path.

Parameters:

path - Path to resolve.

Returns:

The resolved URL.

getSessionId

public static String getSessionId()

Get current request's session id or null if session has not yet been created or if invoked outside the scope of an Execution/ServletRequest.

Returns:

String representing session id or null if session has not yet been created

assertRequest

public static javax.servlet.http.HttpServletRequest assertRequest()

Return request, throwing IllegalStateException if invoked outside the scope of an Execution/ServletRequest

Returns:

HttpServletRequest

Throws:

IllegalStateException - if called outside scope of an HttpServletRequest