org.codehaus.groovy.grails.web.mapping
[Java] Interface UrlMapping

org.codehaus.groovy.grails.web.mapping.UrlCreator
  org.codehaus.groovy.grails.web.mapping.UrlMapping

All Superinterfaces:

UrlCreator

@java.lang.SuppressWarnings("rawtypes")
public interface UrlMapping
extends java.lang.Comparable, UrlCreator

Defines a URL mapping. A URL mapping is a mapping between a URI such as /book/list and a controller, action and/or id.

A UrlMapping should implement Comparable so that UrlMapping instances can be ordered to allow for precendence rules. In other words the URL /book/list should be matched before /book/* as the wildcard is of lesser precedence. By implementing Comparable this can be allowed for.

Authors:

Graeme Rocher

Since:

0.5

ACTION

public java.lang.String ACTION

The action this mapping matches

AMPERSAND

public char AMPERSAND

ANY_HTTP_METHOD

public java.lang.String ANY_HTTP_METHOD

Constant used to define a Url mapping that matches any HTTP method

ANY_VERSION

public java.lang.String ANY_VERSION

Constant used to define a Url mapping that matches any HTTP method

CAPTURED_DOUBLE_WILDCARD

public java.lang.String CAPTURED_DOUBLE_WILDCARD

CAPTURED_WILDCARD

public java.lang.String CAPTURED_WILDCARD

CONTROLLER

public java.lang.String CONTROLLER

The controller this mapping matches

DOUBLE_WILDCARD

public java.lang.String DOUBLE_WILDCARD

HTTP_METHOD

public java.lang.String HTTP_METHOD

The HTTP method this mapping matches

NAMESPACE

public java.lang.String NAMESPACE

The namespace of the URL mapping

OPTIONAL_EXTENSION_WILDCARD

public java.lang.String OPTIONAL_EXTENSION_WILDCARD

PLUGIN

public java.lang.String PLUGIN

The plugin of the URL Mapping

QUESTION_MARK

public char QUESTION_MARK

REDIRECT_INFO

public java.lang.String REDIRECT_INFO

Redirect information for this url mapping.

SLASH

public java.lang.String SLASH

URI

public java.lang.String URI

The URI of the URL mapping

VERSION

public java.lang.String VERSION

The version of the URL mapping

WILDCARD

public java.lang.String WILDCARD

getActionName

public java.lang.Object getActionName()

Retrieves the action name which is either a groovy.lang.Closure that evaluates the action name at runtime or a java.lang.String that represents the action name

Returns:

The action name as a groovy.lang.Closure or java.lang.String

getConstraints

public ConstrainedProperty[] getConstraints()

The constraints the apply to this UrlMapping. Each constraint maps to a GString token in a URL mapping in order. For example consider the URL:

 
     /blog/$author/$title/$year?/$month?/$day?
 

This results in 5 ConstrainedProperty instances called author, title, year, month and day

Returns:

An array containing the ConstrainedProperty objects of this URLMapping

getControllerName

public java.lang.Object getControllerName()

Retrieves the controller name which is either a groovy.lang.Closure that evaluates the controller name at runtime or a java.lang.String that represents the controller name

Returns:

The controller name as a groovy.lang.Closure or java.lang.String

getHttpMethod

public java.lang.String getHttpMethod()

The HTTP method this URL mapping applies to. Will be null for all HTTP methods

Returns:

The HTTP method

getMappingName

public java.lang.String getMappingName()

The name of the mapping in case of named URL mapping

Returns:

The mapping name

getNamespace

public java.lang.Object getNamespace()

Returns:

the name of the controller namespace

getPluginName

public java.lang.Object getPluginName()

The name of the plugin this URL mapping relates to, if any

Returns:

The plugin name

getRedirectInfo

public java.lang.Object getRedirectInfo()

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.

Returns:

redirect information for this url mapping

getUrlData

public UrlMappingData getUrlData()

Retrieves the UrlMappingData instance that describes this UrlMapping

Returns:

The UrlMappingData instance

getVersion

public java.lang.String getVersion()

Returns:

The version of the URL mapping. Used for versioning of REST services

getViewName

public java.lang.Object getViewName()

Returns the name of the view to map to

Returns:

The view name

hasRuntimeVariable

public boolean hasRuntimeVariable(java.lang.String name)

Whether the mapping has a runtime variable with the given name such as "/$foo"

Parameters:

name - The name of the variable

Returns:

true if the mapping has the variable

isRestfulMapping

public boolean isRestfulMapping()

Returns:

Whether this is a RESTful mapping

match

public UrlMappingInfo match(java.lang.String uri)

Matches the given URI and returns an instance of the UrlMappingInfo interface or null if a match couldn't be established

Parameters:

uri - The URI to match

Returns:

An instance of UrlMappingInfo or null if the URI doesn't match

setMappingName

public void setMappingName(java.lang.String name)

Sets the name of the URL mapping

Parameters:

name - The name of the URL mapping

setParameterValues

public void setParameterValues(java.util.Map parameterValues)

Sets any parameter values that should be populated into the request

Parameters:

parameterValues - The parameter values to set

setParseRequest

public void setParseRequest(boolean shouldParse)

Sets whether this UrlMapping should parse the request

Parameters:

shouldParse - True if it should

setRestfulMapping

public void setRestfulMapping(boolean isREST)

Parameters:

isREST - Set whether this is a RESTful mapping

Groovy Documentation