com.aoindustries.servlet.http

Class ServletUtil

java.lang.Object

com.aoindustries.servlet.http.ServletUtil

public class ServletUtil
extends Object

Static utilities that may be useful by servlet/JSP/taglib environments.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_DELETE
static String	METHOD_GET
static String	METHOD_HEAD
static String	METHOD_OPTIONS
static String	METHOD_POST
static String	METHOD_PUT
static String	METHOD_TRACE

Method Summary

Modifier and Type	Method and Description
static <S extends HttpServlet> void	doOptions(HttpServletResponse response, Class<S> stopClass, Class<? extends S> thisClass, String doGet, String doPost, String doPut, String doDelete, Class<?>[] paramTypes) A reusable doOptions implementation for servlets.
static String	getAbsolutePath(HttpServletRequest request, String path)
static String	getAbsolutePath(String servletPath, String relativeUrlPath) Converts a possibly-relative path to a context-relative absolute path.
static String	getAbsoluteURL(HttpServletRequest request, String relPath)
static void	getAbsoluteURL(HttpServletRequest request, String relPath, Appendable out) Gets an absolute URL for the given context-relative path.
static void	getAbsoluteURL(HttpServletRequest request, String relPath, Encoder encoder, Appendable out) Gets an absolute URL for the given context-relative path.
static Method[]	getAllDeclaredMethods(Class<?> stopClass, Class<?> c)
static String	getContextRequestUri(HttpServletRequest request) Gets the current request URI in context-relative form.
static String	getRedirectLocation(HttpServletRequest request, HttpServletResponse response, String servletPath, String href) Gets the absolute URL that should be used for a redirect.
static String	getRequestEncoding(ServletRequest request) Gets the request encoding or ISO-8859-1 when not available.
static URL	getResource(ServletContext servletContext, HttpServletRequest request, String relativeUrlPath) Deprecated. Use regular methods directly
static URL	getResource(ServletContext servletContext, String path) Deprecated. Use regular methods directly
static boolean	isGooglebot(HttpServletRequest request) Determines if the requestor is Googlebot as described at: http://www.google.com/support/webmasters/bin/answer.py?answer=80553
static boolean	resourceExists(ServletContext servletContext, HttpServletRequest request, String relativeUrlPath) Deprecated. Use regular methods directly
static boolean	resourceExists(ServletContext servletContext, String path) Deprecated. Use regular methods directly
static void	sendRedirect(HttpServletRequest request, HttpServletResponse response, String href, int status) Sends a redirect with relative paths determined from the request servlet path.
static void	sendRedirect(HttpServletResponse response, String location, int status) Sends a redirect to the provided absolute URL location.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_DELETE

public static final String METHOD_DELETE

See Also:

Constant Field Values

METHOD_HEAD

public static final String METHOD_HEAD

See Also:

Constant Field Values

METHOD_GET

public static final String METHOD_GET

See Also:

Constant Field Values

METHOD_OPTIONS

public static final String METHOD_OPTIONS

See Also:

Constant Field Values

METHOD_POST

public static final String METHOD_POST

See Also:

Constant Field Values

METHOD_PUT

public static final String METHOD_PUT

See Also:

Constant Field Values

METHOD_TRACE

public static final String METHOD_TRACE

See Also:

Constant Field Values

Method Detail

getRequestEncoding

public static String getRequestEncoding(ServletRequest request)

Gets the request encoding or ISO-8859-1 when not available.

getAbsolutePath

public static String getAbsolutePath(String servletPath,
                                     String relativeUrlPath)
                              throws MalformedURLException

Converts a possibly-relative path to a context-relative absolute path. Resolves ./ and ../ at the beginning of the URL but not in the middle of the URL. If the URL begins with http:, https:, file:, mailto:, telnet:, tel:, or cid:, it is not altered.

Parameters:

servletPath - Required when path might be altered.

Throws:

MalformedURLException

getAbsolutePath

public static String getAbsolutePath(HttpServletRequest request,
                                     String path)
                              throws MalformedURLException

Throws:

MalformedURLException

See Also:

getAbsolutePath(java.lang.String, java.lang.String)

getResource

@Deprecated
public static URL getResource(ServletContext servletContext,
                                          String path)
                                   throws MalformedURLException

Deprecated. Use regular methods directly

Gets the URL for the provided absolute path or null if no resource is mapped to the path.

Throws:

MalformedURLException

See Also:

ServletContext.getResource(java.lang.String), ServletContextCache.getResource(java.lang.String), ServletContextCache.getResource(javax.servlet.ServletContext, java.lang.String)

getResource

@Deprecated
public static URL getResource(ServletContext servletContext,
                                          HttpServletRequest request,
                                          String relativeUrlPath)
                                   throws MalformedURLException

Deprecated. Use regular methods directly

Gets the URL for the provided possibly-relative path or null if no resource is mapped to the path.

Throws:

MalformedURLException

See Also:

getAbsoluteURL(javax.servlet.http.HttpServletRequest, java.lang.String), ServletContext.getResource(java.lang.String), ServletContextCache.getResource(java.lang.String), ServletContextCache.getResource(javax.servlet.ServletContext, java.lang.String)

resourceExists

@Deprecated
public static boolean resourceExists(ServletContext servletContext,
                                                 String path)
                                          throws MalformedURLException

Deprecated. Use regular methods directly

Checks if a resource with the possibly-relative path exists.

Throws:

MalformedURLException

See Also:

ServletContext.getResource(java.lang.String), ServletContextCache.getResource(java.lang.String), ServletContextCache.getResource(javax.servlet.ServletContext, java.lang.String)

resourceExists

@Deprecated
public static boolean resourceExists(ServletContext servletContext,
                                                 HttpServletRequest request,
                                                 String relativeUrlPath)
                                          throws MalformedURLException

Deprecated. Use regular methods directly

Checks if a resource with the possibly-relative path exists.

Throws:

MalformedURLException

See Also:

getAbsoluteURL(javax.servlet.http.HttpServletRequest, java.lang.String), ServletContext.getResource(java.lang.String), ServletContextCache.getResource(java.lang.String), ServletContextCache.getResource(javax.servlet.ServletContext, java.lang.String)

isGooglebot

public static boolean isGooglebot(HttpServletRequest request)

Determines if the requestor is Googlebot as described at: http://www.google.com/support/webmasters/bin/answer.py?answer=80553

getAbsoluteURL

public static String getAbsoluteURL(HttpServletRequest request,
                                    String relPath)

See Also:

getAbsoluteURL(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.Appendable)

getAbsoluteURL

public static void getAbsoluteURL(HttpServletRequest request,
                                  String relPath,
                                  Appendable out)
                           throws IOException

Gets an absolute URL for the given context-relative path. This includes protocol, port, context path, and relative path. No URL rewriting is performed.

Throws:

IOException

getAbsoluteURL

public static void getAbsoluteURL(HttpServletRequest request,
                                  String relPath,
                                  Encoder encoder,
                                  Appendable out)
                           throws IOException

Gets an absolute URL for the given context-relative path. This includes protocol, port, context path, and relative path. No URL rewriting is performed.

Throws:

IOException

getRedirectLocation

public static String getRedirectLocation(HttpServletRequest request,
                                         HttpServletResponse response,
                                         String servletPath,
                                         String href)
                                  throws MalformedURLException,
                                         UnsupportedEncodingException

Gets the absolute URL that should be used for a redirect.

Parameters:

href - The absolute, context-relative, or page-relative path to redirect to. The following actions are performed on the provided href:

1. Convert page-relative paths to context-relative path, resolving ./ and ../
2. Encode URL path elements (like Japanese filenames)
3. Perform URL rewriting (response.encodeRedirectURL)
4. Convert to absolute URL if needed. This will also add the context path.

Throws:

MalformedURLException

UnsupportedEncodingException

See Also:

sendRedirect(javax.servlet.http.HttpServletResponse, java.lang.String, int)

sendRedirect

public static void sendRedirect(HttpServletResponse response,
                                String location,
                                int status)
                         throws IllegalStateException,
                                IOException

Sends a redirect to the provided absolute URL location.

Throws:

IllegalStateException

IOException

See Also:

getRedirectLocation(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)

sendRedirect

public static void sendRedirect(HttpServletRequest request,
                                HttpServletResponse response,
                                String href,
                                int status)
                         throws IllegalStateException,
                                IOException

Sends a redirect with relative paths determined from the request servlet path.

Throws:

IllegalStateException

IOException

See Also:

for transformations applied to the href

getContextRequestUri

public static String getContextRequestUri(HttpServletRequest request)

Gets the current request URI in context-relative form. The contextPath stripped.

getAllDeclaredMethods

public static Method[] getAllDeclaredMethods(Class<?> stopClass,
                                             Class<?> c)

doOptions

public static <S extends HttpServlet> void doOptions(HttpServletResponse response,
                                                     Class<S> stopClass,
                                                     Class<? extends S> thisClass,
                                                     String doGet,
                                                     String doPost,
                                                     String doPut,
                                                     String doDelete,
                                                     Class<?>[] paramTypes)

A reusable doOptions implementation for servlets.