|
Groovy Documentation | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD | |||||||
public interface UrlMappingsHolder
Main entry point of Grails URL mapping mechanism. This interface defines methods to match URLs and create reverse mappings based on the UrlMapping instances the implementor contains.
| Field Summary | |
|---|---|
java.lang.String |
BEAN_ID
|
| Method Summary | |
|---|---|
java.util.List
|
getExcludePatterns()
Retrieves the held Exclude Pattern instances as a list, could be null if there is no exclude |
UrlCreator
|
getReverseMapping(java.lang.String controller, java.lang.String action, java.lang.String pluginName, java.util.Map params)
Retrieves the best guess of a URI for the given controller, action and parameters |
UrlCreator
|
getReverseMapping(java.lang.String controller, java.lang.String action, java.util.Map params)
Retrieves the best guess of a URI for the given controller, action and parameters |
UrlCreator
|
getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.util.Map params)
Retrieves the best guess of a URI for the given controller, action and parameters or null if non could be found. |
UrlCreator
|
getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.lang.String pluginName, java.util.Map params)
Retrieves the best guess of a URI for the given controller, action and parameters or null if non could be found. |
UrlMapping[]
|
getUrlMappings()
Retrieves the held UrlMapping instances as an array |
UrlMappingInfo
|
match(java.lang.String uri)
Match and return the first UrlMappingInfo instance possible |
UrlMappingInfo[]
|
matchAll(java.lang.String uri)
Matches all possible UrlMappingInfo instances to the given URI and returns them all |
UrlMappingInfo[]
|
matchAll(java.lang.String uri, java.lang.String httpMethod)
Match all possible UrlMappingInfo instances to the given URI and HTTP method |
UrlMappingInfo
|
matchStatusCode(int responseCode)
Match and return the first UrlMappingInfo instance possible |
UrlMappingInfo
|
matchStatusCode(int responseCode, java.lang.Throwable e)
Match and return for first UrlMappingInfo for the give response code and exception |
| Field Detail |
|---|
public java.lang.String BEAN_ID
| Method Detail |
|---|
@SuppressWarnings("rawtypes")
public java.util.List getExcludePatterns()
@SuppressWarnings("rawtypes")
public UrlCreator getReverseMapping(java.lang.String controller, java.lang.String action, java.lang.String pluginName, java.util.Map params)
controller - The name of the controlleraction - The name of the action or nullpluginName - the name of the plugin which provides the controllerparams - The parameters or null
@SuppressWarnings("rawtypes")
public UrlCreator getReverseMapping(java.lang.String controller, java.lang.String action, java.util.Map params)
controller - The name of the controlleraction - The name of the action or nullparams - The parameters or null
@SuppressWarnings("rawtypes")
public UrlCreator getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.util.Map params)
controller - The name of the controlleraction - The name of the action or nullparams - The parameters or null
@SuppressWarnings("rawtypes")
public UrlCreator getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.lang.String pluginName, java.util.Map params)
controller - The name of the controlleraction - The name of the action or nullpluginName - the name of the plugin which provides the controllerparams - The parameters or null
public UrlMapping[] getUrlMappings()
public UrlMappingInfo match(java.lang.String uri)
uri - The URI to match
public UrlMappingInfo[] matchAll(java.lang.String uri)
uri - The URI to match
public UrlMappingInfo[] matchAll(java.lang.String uri, java.lang.String httpMethod)
uri - The URI to matchhttpMethod - The HTTP method (GET,POST,PUT,DELETE etc.)
public UrlMappingInfo matchStatusCode(int responseCode)
responseCode - The responseCode to match
public UrlMappingInfo matchStatusCode(int responseCode, java.lang.Throwable e)
responseCode - The response codee - The exception
Groovy Documentation