org.codehaus.groovy.grails.web.mapping

Class UrlMappingUtils

java.lang.Object

org.codehaus.groovy.grails.web.mapping.UrlMappingUtils

public class UrlMappingUtils
extends java.lang.Object

Utility methods for working with UrlMappings

Since:

2.4

Constructor Summary

Constructors

Constructor and Description
UrlMappingUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildDispatchUrlForMapping(UrlMappingInfo info) Constructs the URI to forward to using the given request and UrlMappingInfo instance
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	forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, UrlMappingInfo info, java.util.Map model, boolean includeParams) Forwards a request for the given UrlMappingInfo object and model
static org.codehaus.groovy.grails.commons.GrailsClass	getConfiguredControllerForUrlMappingInfo(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest, UrlMappingInfo info, grails.web.UrlConverter urlConverterToUse, org.codehaus.groovy.grails.commons.GrailsApplication grailsApplicationToUse) Deprecated.
static java.lang.String	getControllerFeatureURI(grails.web.UrlConverter urlConverter, java.lang.String controller, java.lang.String action)
static org.codehaus.groovy.grails.commons.ControllerArtefactHandler.ControllerCacheKey	getFeatureId(grails.web.UrlConverter urlConverter, UrlMappingInfo info)
static org.codehaus.groovy.grails.web.util.IncludedContent	includeForUrl(java.lang.String includeUrl, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map model) Includes the given URL returning the resulting content as a String
static org.codehaus.groovy.grails.web.util.IncludedContent	includeForUrlMappingInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, UrlMappingInfo info, java.util.Map model) Include whatever the given UrlMappingInfo maps to within the current response
static UrlMappingsHolder	lookupUrlMappings(javax.servlet.ServletContext servletContext) Looks up the UrlMappingsHolder instance
protected static void	passControllerForForwardedRequest(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest, UrlMappingInfo info)
static org.codehaus.groovy.grails.commons.GrailsClass	passControllerForUrlMappingInfoInRequest(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest, UrlMappingInfo info, grails.web.UrlConverter urlConverterToUse, org.codehaus.groovy.grails.commons.GrailsApplication grailsApplicationToUse)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlMappingUtils

public UrlMappingUtils()

Method Detail

lookupUrlMappings

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

Looks up the UrlMappingsHolder instance

Parameters:

servletContext - The ServletContext object

Returns:

The UrlMappingsHolder

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

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

See Also:

forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.codehaus.groovy.grails.web.mapping.UrlMappingInfo, java.util.Map)

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

See Also:

forwardRequestForUrlMappingInfo(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.codehaus.groovy.grails.web.mapping.UrlMappingInfo, java.util.Map, boolean)

forwardRequestForUrlMappingInfo

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

Forwards a request for the given UrlMappingInfo object and model

Parameters:

request - The request

response - The response

info - The UrlMappingInfo object

model - The Model

includeParams - Whether to include any request parameters

Returns:

The URI forwarded too

Throws:

javax.servlet.ServletException - Thrown when an error occurs executing the forward

java.io.IOException - Thrown when an error occurs executing the forward

passControllerForForwardedRequest

protected static void passControllerForForwardedRequest(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest,
                                                        UrlMappingInfo info)

includeForUrlMappingInfo

public static org.codehaus.groovy.grails.web.util.IncludedContent includeForUrlMappingInfo(javax.servlet.http.HttpServletRequest request,
                                                                                           javax.servlet.http.HttpServletResponse response,
                                                                                           UrlMappingInfo info,
                                                                                           java.util.Map model)

Include whatever the given UrlMappingInfo maps to within the current response

Parameters:

request - The request

response - The response

info - The UrlMappingInfo

model - The model

Returns:

The included content

includeForUrl

public static org.codehaus.groovy.grails.web.util.IncludedContent includeForUrl(java.lang.String includeUrl,
                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                javax.servlet.http.HttpServletResponse response,
                                                                                java.util.Map model)

Includes the given URL returning the resulting content as a String

Parameters:

includeUrl - The URL to include

request - The request

response - The response

model - The model

Returns:

The content

passControllerForUrlMappingInfoInRequest

public static org.codehaus.groovy.grails.commons.GrailsClass passControllerForUrlMappingInfoInRequest(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest,
                                                                                                      UrlMappingInfo info,
                                                                                                      grails.web.UrlConverter urlConverterToUse,
                                                                                                      org.codehaus.groovy.grails.commons.GrailsApplication grailsApplicationToUse)

getFeatureId

public static org.codehaus.groovy.grails.commons.ControllerArtefactHandler.ControllerCacheKey getFeatureId(grails.web.UrlConverter urlConverter,
                                                                                                           UrlMappingInfo info)

getControllerFeatureURI

public static java.lang.String getControllerFeatureURI(grails.web.UrlConverter urlConverter,
                                                       java.lang.String controller,
                                                       java.lang.String action)

getConfiguredControllerForUrlMappingInfo

@Deprecated
public static org.codehaus.groovy.grails.commons.GrailsClass getConfiguredControllerForUrlMappingInfo(org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest webRequest,
                                                                                                                  UrlMappingInfo info,
                                                                                                                  grails.web.UrlConverter urlConverterToUse,
                                                                                                                  org.codehaus.groovy.grails.commons.GrailsApplication grailsApplicationToUse)

Deprecated.