org.codehaus.groovy.grails.web.mapping

Class DefaultUrlMappingInfo

java.lang.Object

org.codehaus.groovy.grails.web.mapping.AbstractUrlMappingInfo

org.codehaus.groovy.grails.web.mapping.DefaultUrlMappingInfo

All Implemented Interfaces:

UrlMappingInfo

public class DefaultUrlMappingInfo
extends AbstractUrlMappingInfo

Holds information established from a matched URL.

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
DefaultUrlMappingInfo(java.lang.Object viewName, java.util.Map params, UrlMappingData urlData, javax.servlet.ServletContext servletContext)
DefaultUrlMappingInfo(java.lang.Object redirectInfo, java.lang.Object controllerName, java.lang.Object actionName, java.lang.Object namespace, java.lang.Object pluginName, java.lang.Object viewName, java.util.Map params, UrlMappingData urlData, javax.servlet.ServletContext servletContext)
DefaultUrlMappingInfo(java.lang.Object redirectInfo, java.lang.Object controllerName, java.lang.Object actionName, java.lang.Object namespace, java.lang.Object pluginName, java.lang.Object viewName, java.lang.String httpMethod, java.lang.String version, java.util.Map<?,?> params, UrlMappingData urlData, javax.servlet.ServletContext servletContext)
DefaultUrlMappingInfo(java.lang.Object uri, java.lang.String httpMethod, UrlMappingData data, javax.servlet.ServletContext servletContext)
DefaultUrlMappingInfo(java.lang.Object uri, UrlMappingData data, javax.servlet.ServletContext servletContext)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActionName() The name of the action that the URL mappping maps to
java.lang.String	getControllerName() The name of the controller that the URL mapping maps to
java.lang.String	getHttpMethod() The HTTP method that this URL mapping maps to
java.lang.String	getId() The id part of the URL mapping if any
java.lang.String	getNamespace()
java.util.Map	getParameters() The parameters that were extracted from the URI that was matched
java.lang.String	getPluginName() The name of the plugin that this UrlMappingInfo maps to
java.lang.Object	getRedirectInfo() The redirect information should be a String or a Map.
java.lang.String	getURI() The URI to map to.
java.lang.String	getVersion()
java.lang.String	getViewName() The name of the view that the URL mappping maps to
boolean	isParsingRequest() Returns true of the request body should be parsed.
void	setParsingRequest(boolean parsingRequest)
java.lang.String	toString()

Methods inherited from class org.codehaus.groovy.grails.web.mapping.AbstractUrlMappingInfo

configure, evaluateNameForValue, evaluateNameForValue, getParams, populateParamsForMapping, setParams

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUrlMappingInfo

public DefaultUrlMappingInfo(java.lang.Object redirectInfo,
                     java.lang.Object controllerName,
                     java.lang.Object actionName,
                     java.lang.Object namespace,
                     java.lang.Object pluginName,
                     java.lang.Object viewName,
                     java.util.Map params,
                     UrlMappingData urlData,
                     javax.servlet.ServletContext servletContext)

DefaultUrlMappingInfo

public DefaultUrlMappingInfo(java.lang.Object redirectInfo,
                     java.lang.Object controllerName,
                     java.lang.Object actionName,
                     java.lang.Object namespace,
                     java.lang.Object pluginName,
                     java.lang.Object viewName,
                     java.lang.String httpMethod,
                     java.lang.String version,
                     java.util.Map<?,?> params,
                     UrlMappingData urlData,
                     javax.servlet.ServletContext servletContext)

DefaultUrlMappingInfo

public DefaultUrlMappingInfo(java.lang.Object viewName,
                     java.util.Map params,
                     UrlMappingData urlData,
                     javax.servlet.ServletContext servletContext)

DefaultUrlMappingInfo

public DefaultUrlMappingInfo(java.lang.Object uri,
                     UrlMappingData data,
                     javax.servlet.ServletContext servletContext)

DefaultUrlMappingInfo

public DefaultUrlMappingInfo(java.lang.Object uri,
                     java.lang.String httpMethod,
                     UrlMappingData data,
                     javax.servlet.ServletContext servletContext)

Method Detail

getVersion

public java.lang.String getVersion()

Returns:

The version of the API (for REST)

getHttpMethod

public java.lang.String getHttpMethod()

Description copied from interface: UrlMappingInfo

The HTTP method that this URL mapping maps to

Returns:

The http method

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getParameters

public java.util.Map getParameters()

Description copied from interface: UrlMappingInfo

The parameters that were extracted from the URI that was matched

Returns:

A Map of parameters

isParsingRequest

public boolean isParsingRequest()

Description copied from interface: UrlMappingInfo

Returns true of the request body should be parsed. This typically happens in the case of REST requests that parse JSON or XML packets

Returns:

true if it is

setParsingRequest

public void setParsingRequest(boolean parsingRequest)

getPluginName

public java.lang.String getPluginName()

Description copied from interface: UrlMappingInfo

The name of the plugin that this UrlMappingInfo maps to

Returns:

The plugin name

getNamespace

public java.lang.String getNamespace()

Returns:

the namespace of the corresponding controller, null if none was specified

getControllerName

public java.lang.String getControllerName()

Description copied from interface: UrlMappingInfo

The name of the controller that the URL mapping maps to

Returns:

The name of the controller

getActionName

public java.lang.String getActionName()

Description copied from interface: UrlMappingInfo

The name of the action that the URL mappping maps to

Returns:

The name of the action or null if not known

getViewName

public java.lang.String getViewName()

Description copied from interface: UrlMappingInfo

The name of the view that the URL mappping maps to

Returns:

The name of the view or null if not known

getId

public java.lang.String getId()

Description copied from interface: UrlMappingInfo

The id part of the URL mapping if any

Returns:

The id or null

getURI

public java.lang.String getURI()

Description copied from interface: UrlMappingInfo

The URI to map to. Note when the URI is specified it overrides any explicit controller/action/id mappings. In other words you can either specify the URI or the controller/action/id, but not both

Returns:

The URI to use

getRedirectInfo

public java.lang.Object getRedirectInfo()

Description copied from class: AbstractUrlMappingInfo

The redirect information should be a String or a Map. If it is a String that string is the URI to redirect to. If it is a Map, that Map may contain any entries supported as arguments to the dynamic redirect(Map) method on a controller.

Specified by:

getRedirectInfo in interface UrlMappingInfo

Overrides:

getRedirectInfo in class AbstractUrlMappingInfo

Returns:

redirect information for this url mapping, null if no redirect is specified