org.codehaus.groovy.grails.web.util
Class WebUtils

java.lang.Object
  org.springframework.web.util.WebUtils
      org.codehaus.groovy.grails.web.util.WebUtils

public class WebUtils
extends org.springframework.web.util.WebUtils

Utility methods to access commons objects and perform common web related functions for the internal framework

Since:

1.0

Created: Oct 10, 2007

Author:

Graeme Rocher

Field Summary

static java.lang.String	DISPATCH_ACTION_PARAMETER
static java.lang.String	ENABLE_FILE_EXTENSIONS
static char	SLASH

Fields inherited from class org.springframework.web.util.WebUtils

CONTENT_TYPE_CHARSET_PREFIX, DEFAULT_CHARACTER_ENCODING, DEFAULT_WEB_APP_ROOT_KEY, FORWARD_CONTEXT_PATH_ATTRIBUTE, FORWARD_PATH_INFO_ATTRIBUTE, FORWARD_QUERY_STRING_ATTRIBUTE, FORWARD_REQUEST_URI_ATTRIBUTE, FORWARD_SERVLET_PATH_ATTRIBUTE, HTML_ESCAPE_CONTEXT_PARAM, INCLUDE_CONTEXT_PATH_ATTRIBUTE, INCLUDE_PATH_INFO_ATTRIBUTE, INCLUDE_QUERY_STRING_ATTRIBUTE, INCLUDE_REQUEST_URI_ATTRIBUTE, INCLUDE_SERVLET_PATH_ATTRIBUTE, SESSION_MUTEX_ATTRIBUTE, SUBMIT_IMAGE_SUFFIXES, TEMP_DIR_CONTEXT_ATTRIBUTE, WEB_APP_ROOT_KEY_PARAM

Constructor Summary

WebUtils()

Method Summary

static boolean	areFileExtensionsEnabled() Returns the value of the "grails.mime.file.extensions" setting configured in COnfig.groovy
static java.lang.String	buildDispatchUrlForMapping(UrlMappingInfo info) Constructs the URI to forward to using the given request and UrlMappingInfo instance
static void	clearGrailsWebRequest() Removes any GrailsWebRequest instance from the current request.
static java.lang.String	forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, UrlMappingInfo info)
static java.lang.String	forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, UrlMappingInfo info, java.util.Map model)
static java.lang.String	getFormatFromURI(java.lang.String uri) Obtains the format from the URI.
static GrailsApplication	lookupApplication(javax.servlet.ServletContext servletContext) Looks up the GrailsApplication instance
static UrlMappingsHolder	lookupUrlMappings(javax.servlet.ServletContext servletContext) Looks up the UrlMappingsHolder instance
static org.springframework.web.servlet.ViewResolver	lookupViewResolver(javax.servlet.ServletContext servletContext)
static org.springframework.web.servlet.View	resolveView(javax.servlet.http.HttpServletRequest request, java.lang.String viewName, java.lang.String controllerName, org.springframework.web.servlet.ViewResolver viewResolver) Resolves a view for the given view name and controller name
static org.springframework.web.servlet.View	resolveView(javax.servlet.http.HttpServletRequest request, UrlMappingInfo info, java.lang.String viewName, org.springframework.web.servlet.ViewResolver viewResolver) Resolves a view for the given view and UrlMappingInfo instance
static GrailsWebRequest	retrieveGrailsWebRequest() Returns the GrailsWebRequest associated with the current request.
static void	storeGrailsWebRequest(GrailsWebRequest webRequest) Helper method to store the given GrailsWebRequest for the current request.

Methods inherited from class org.springframework.web.util.WebUtils

exposeForwardRequestAttributes, exposeRequestAttributes, extractFilenameFromUrlPath, findParameterValue, findParameterValue, getCookie, getDefaultHtmlEscape, getOrCreateSessionAttribute, getParametersStartingWith, getRealPath, getRequiredSessionAttribute, getSessionAttribute, getSessionId, getSessionMutex, getTargetPage, getTempDir, hasSubmitParameter, isDefaultHtmlEscape, isIncludeRequest, removeWebAppRootSystemProperty, setSessionAttribute, setWebAppRootSystemProperty

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final char SLASH

See Also:

Constant Field Values

ENABLE_FILE_EXTENSIONS

public static final java.lang.String ENABLE_FILE_EXTENSIONS

See Also:

Constant Field Values

DISPATCH_ACTION_PARAMETER

public static final java.lang.String DISPATCH_ACTION_PARAMETER

See Also:

Constant Field Values

Constructor Detail

WebUtils

public WebUtils()

Method Detail

lookupViewResolver

public static org.springframework.web.servlet.ViewResolver lookupViewResolver(javax.servlet.ServletContext servletContext)

lookupUrlMappings

public static UrlMappingsHolder lookupUrlMappings(javax.servlet.ServletContext servletContext)

Looks up the UrlMappingsHolder instance

Parameters:

servletContext - The ServletContext object

Returns:

The UrlMappingsHolder

lookupApplication

public static GrailsApplication lookupApplication(javax.servlet.ServletContext servletContext)

Looks up the GrailsApplication instance

Returns:

The GrailsApplication instance

resolveView

public static org.springframework.web.servlet.View resolveView(javax.servlet.http.HttpServletRequest request,
                                                               UrlMappingInfo info,
                                                               java.lang.String viewName,
                                                               org.springframework.web.servlet.ViewResolver viewResolver)
                                                        throws java.lang.Exception

Resolves a view for the given view and UrlMappingInfo instance

Parameters:

request - The request

info - The info

viewName - The view name

viewResolver - The view resolver

Returns:

The view or null

Throws:

java.lang.Exception

resolveView

public static org.springframework.web.servlet.View resolveView(javax.servlet.http.HttpServletRequest request,
                                                               java.lang.String viewName,
                                                               java.lang.String controllerName,
                                                               org.springframework.web.servlet.ViewResolver viewResolver)
                                                        throws java.lang.Exception

Resolves a view for the given view name and controller name

Parameters:

request - The request

viewName - The view name

controllerName - The controller name

viewResolver - The resolver

Returns:

A View or null

Throws:

java.lang.Exception - Thrown if an error occurs

buildDispatchUrlForMapping

public static java.lang.String buildDispatchUrlForMapping(UrlMappingInfo info)

Constructs the URI to forward to using the given request and UrlMappingInfo instance

Parameters:

info - The UrlMappingInfo

Returns:

The URI to forward to

forwardRequestForUrlMappingInfo

public static java.lang.String forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response,
                                                               UrlMappingInfo info)
                                                        throws javax.servlet.ServletException,
                                                               java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException

forwardRequestForUrlMappingInfo

public static java.lang.String forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response,
                                                               UrlMappingInfo info,
                                                               java.util.Map model)
                                                        throws javax.servlet.ServletException,
                                                               java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException

getFormatFromURI

public static java.lang.String getFormatFromURI(java.lang.String uri)

Obtains the format from the URI. The format is the string following the . file extension in the last token of the URI

Parameters:

uri - The URI

Returns:

The format or null if none

areFileExtensionsEnabled

public static boolean areFileExtensionsEnabled()

Returns the value of the "grails.mime.file.extensions" setting configured in COnfig.groovy

Returns:

True if file extensions are enabled

retrieveGrailsWebRequest

public static GrailsWebRequest retrieveGrailsWebRequest()

Returns the GrailsWebRequest associated with the current request. This is the preferred means of accessing the GrailsWebRequest instance. If the exception is undesired, you can use RequestContextHolder.getRequestAttributes() instead.

Throws:

java.lang.IllegalStateException - if this is called outside of a request.

storeGrailsWebRequest

public static void storeGrailsWebRequest(GrailsWebRequest webRequest)

Helper method to store the given GrailsWebRequest for the current request. Ensures consistency between RequestContextHolder and the relevant request attribute. This is the preferred means of updating the current web request.

clearGrailsWebRequest

public static void clearGrailsWebRequest()

Removes any GrailsWebRequest instance from the current request.