UrlMappingUtils (Grace Framework

org.grails.web.mapping.UrlMappingUtils

@SuppressWarnings("unchecked")
public final class UrlMappingUtils
extends Object

Utility methods for working with UrlMappings

Authors:: Graeme Rocher

Since:: 2.4

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static String`	`buildDispatchUrlForMapping(UrlMappingInfo info)` Constructs the URI to forward to using the given request and UrlMappingInfo instance
	`public static Map`	`findAllParamsNotInKeys(Map params, Set keys)`
	`public static Map`	`findAllParamsNotInUrlMappingKeywords(Map params)` Returns: a Map without entries whose key belongs to UrlMapping#KEYWORDS
	`public static String`	`forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info)` See Also: forwardRequestForUrlMappingInfo
	`public static String`	`forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)` See Also: forwardRequestForUrlMappingInfo
	`public static String`	`forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map<String, Object> model, boolean includeParams)` Forwards a request for the given UrlMappingInfo object and model
	`public static IncludedContent`	`includeForUrl(String includeUrl, HttpServletRequest request, HttpServletResponse response, Map model)` Includes the given URL returning the resulting content as a String
	`public static IncludedContent`	`includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)` Include whatever the given UrlMappingInfo maps to within the current response
	`public static IncludedContent`	`includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model, LinkGenerator linkGenerator)` Include whatever the given UrlMappingInfo maps to within the current response
	`public static UrlMappingsHolder`	`lookupUrlMappings(ServletContext servletContext)` Looks up the UrlMappingsHolder instance
	`public static View`	`resolveView(HttpServletRequest request, UrlMappingInfo info, String viewName, ViewResolver viewResolver)` Resolves a view for the given view and UrlMappingInfo instance

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Method Detail
  - public static 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
  - public static Map findAllParamsNotInKeys(Map params, Set keys)
  - public static Map findAllParamsNotInUrlMappingKeywords(Map params)
    
    Returns:
    a Map without entries whose key belongs to UrlMapping#KEYWORDS
  - public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info)
    
    See Also:
    forwardRequestForUrlMappingInfo
  - @SuppressWarnings("rawtypes")
    public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)
    
    See Also:
    forwardRequestForUrlMappingInfo
  - public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map<String, Object> model, boolean includeParams)
    
    Forwards a request for the given UrlMappingInfo object and model
    throws:
    jakarta.servlet.ServletException Thrown when an error occurs executing the forward
    throws:
    java.io.IOException Thrown when an error occurs executing the forward
    
    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
  - @SuppressWarnings({ "unchecked", "rawtypes" })
    public static IncludedContent includeForUrl(String includeUrl, HttpServletRequest request, HttpServletResponse response, 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
  - @SuppressWarnings({ "rawtypes" })
    public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, 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
  - @SuppressWarnings({ "rawtypes" })
    public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model, LinkGenerator linkGenerator)
    
    Include whatever the given UrlMappingInfo maps to within the current response
    Parameters:
    request - The request
    response - The response
    info - The UrlMappingInfo
    model - The model
    linkGenerator - allows for reverse url mapping
    Returns:
    The included content
  - public static UrlMappingsHolder lookupUrlMappings(ServletContext servletContext)
    
    Looks up the UrlMappingsHolder instance
    Returns:
    The UrlMappingsHolder
    Parameters:
    servletContext - The ServletContext object
  - public static View resolveView(HttpServletRequest request, UrlMappingInfo info, String viewName, ViewResolver viewResolver)
    
    Resolves a view for the given view and UrlMappingInfo instance
    throws:
    Exception
    
    Parameters:
    request - The request
    info - The info
    viewName - The view name
    viewResolver - The view resolver
    Returns:
    The view or null

Summary:
Method

| Detail:
Method

[Java] Class UrlMappingUtils

Methods Summary

Inherited Methods Summary

Method Detail

public static String buildDispatchUrlForMapping(UrlMappingInfo info)

public static Map findAllParamsNotInKeys(Map params, Set keys)

public static Map findAllParamsNotInUrlMappingKeywords(Map params)

public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info)

@SuppressWarnings("rawtypes")
public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map<String, Object> model, boolean includeParams)

@SuppressWarnings({ "unchecked", "rawtypes" })
public static IncludedContent includeForUrl(String includeUrl, HttpServletRequest request, HttpServletResponse response, Map model)

@SuppressWarnings({ "rawtypes" })
public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

@SuppressWarnings({ "rawtypes" })
public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model, LinkGenerator linkGenerator)

public static UrlMappingsHolder lookupUrlMappings(ServletContext servletContext)

public static View resolveView(HttpServletRequest request, UrlMappingInfo info, String viewName, ViewResolver viewResolver)

[Java] Class UrlMappingUtils

Methods Summary

Inherited Methods Summary

Method Detail

public static String buildDispatchUrlForMapping(UrlMappingInfo info)

public static Map findAllParamsNotInKeys(Map params, Set keys)

public static Map findAllParamsNotInUrlMappingKeywords(Map params)

public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info)

@SuppressWarnings("rawtypes")public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map<String, Object> model, boolean includeParams)

@SuppressWarnings({ "unchecked", "rawtypes" })public static IncludedContent includeForUrl(String includeUrl, HttpServletRequest request, HttpServletResponse response, Map model)

@SuppressWarnings({ "rawtypes" })public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

@SuppressWarnings({ "rawtypes" })public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model, LinkGenerator linkGenerator)

public static UrlMappingsHolder lookupUrlMappings(ServletContext servletContext)

public static View resolveView(HttpServletRequest request, UrlMappingInfo info, String viewName, ViewResolver viewResolver)

@SuppressWarnings("rawtypes")
public static String forwardRequestForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

@SuppressWarnings({ "unchecked", "rawtypes" })
public static IncludedContent includeForUrl(String includeUrl, HttpServletRequest request, HttpServletResponse response, Map model)

@SuppressWarnings({ "rawtypes" })
public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model)

@SuppressWarnings({ "rawtypes" })
public static IncludedContent includeForUrlMappingInfo(HttpServletRequest request, HttpServletResponse response, UrlMappingInfo info, Map model, LinkGenerator linkGenerator)