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 implementer contains.
| Modifiers | Name | Description |
|---|---|---|
java.lang.String |
BEAN_ID |
| Type Params | Return Type | Name and description |
|---|---|---|
|
public java.util.Set<org.springframework.http.HttpMethod> |
allowedMethods(java.lang.String uri)Return the allowed HTTP methods for the given URI |
|
public java.util.List |
getExcludePatterns()Retrieves the held Exclude Pattern instances as a list, could be null if there is no exclude |
|
public 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 |
|
public UrlCreator |
getReverseMapping(java.lang.String controller, java.lang.String action, java.lang.String namespace, java.lang.String pluginName, java.lang.String httpMethod, java.util.Map params)Retrieves the best guess of a URI for the given controller, action and parameters |
|
public UrlCreator |
getReverseMapping(java.lang.String controller, java.lang.String action, java.lang.String namespace, java.lang.String pluginName, java.lang.String httpMethod, java.lang.String version, java.util.Map params)Retrieves the best guess of a URI for the given controller, action and parameters |
|
public UrlCreator |
getReverseMapping(java.lang.String controller, java.lang.String action, java.lang.String namespace, java.lang.String pluginName, java.util.Map params)Retrieves the best guess of a URI for the given controller, action and parameters |
|
public 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 |
|
public 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. |
|
public UrlCreator |
getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.lang.String namespace, java.lang.String pluginName, java.lang.String httpMethod, 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. |
|
public UrlCreator |
getReverseMappingNoDefault(java.lang.String controller, java.lang.String action, java.lang.String namespace, java.lang.String pluginName, java.lang.String httpMethod, java.lang.String version, 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. |
|
public UrlMapping[] |
getUrlMappings()Retrieves the held UrlMapping instances as an array |
|
public UrlMappingInfo |
match(java.lang.String uri)Match and return the first UrlMappingInfo instance possible |
|
public UrlMappingInfo[] |
matchAll(java.lang.String uri)Matches all possible UrlMappingInfo instances to the given URI and returns them all |
|
public UrlMappingInfo[] |
matchAll(java.lang.String uri, java.lang.String httpMethod)Match all possible UrlMappingInfo instances to the given URI and HTTP method |
|
public UrlMappingInfo[] |
matchAll(java.lang.String uri, java.lang.String httpMethod, java.lang.String version)Match all possible UrlMappingInfo instances to the given URI and HTTP method |
|
public UrlMappingInfo[] |
matchAll(java.lang.String uri, org.springframework.http.HttpMethod httpMethod)Match all possible UrlMappingInfo instances to the given URI and HTTP method |
|
public UrlMappingInfo[] |
matchAll(java.lang.String uri, org.springframework.http.HttpMethod httpMethod, java.lang.String version)Match all possible UrlMappingInfo instances to the given URI and HTTP method |
|
public UrlMappingInfo |
matchStatusCode(int responseCode)Match and return the first UrlMappingInfo instance possible |
|
public UrlMappingInfo |
matchStatusCode(int responseCode, java.lang.Throwable e)Match and return for first UrlMappingInfo for the give response code and exception |
Return the allowed HTTP methods for the given URI
uri - The URIRetrieves the held Exclude Pattern instances as a list, could be null if there is no exclude
Retrieves the best guess of a URI for the given controller, action and parameters
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 nullRetrieves the best guess of a URI for the given controller, action and parameters
controller - The name of the controlleraction - The name of the action or nullnamespace - The controller namespacepluginName - the name of the plugin which provides the controllerhttpMethod - The HTTP method to reverse mapparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters
controller - The name of the controlleraction - The name of the action or nullnamespace - The controller namespacepluginName - the name of the plugin which provides the controllerhttpMethod - The HTTP method to reverse mapversion - The version of the mappingparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters
controller - The name of the controlleraction - The name of the action or nullnamespace - The controller namespace or nullpluginName - the name of the plugin which provides the controllerparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters
controller - The name of the controlleraction - The name of the action or nullparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters or null if non could be found.
controller - The name of the controlleraction - The name of the action or nullparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters or null if non could be found.
controller - The name of the controlleraction - The name of the action or nullnamespace - The controller namespace or nullpluginName - the name of the plugin which provides the controllerhttpMethod - the HTTP methodparams - The parameters or nullRetrieves the best guess of a URI for the given controller, action and parameters or null if non could be found.
controller - The name of the controlleraction - The name of the action or nullnamespace - The controller namespace or nullpluginName - the name of the plugin which provides the controllerhttpMethod - the HTTP methodparams - The parameters or nullRetrieves the held UrlMapping instances as an array
Match and return the first UrlMappingInfo instance possible
uri - The URI to matchMatches all possible UrlMappingInfo instances to the given URI and returns them all
uri - The URI to matchMatch all possible UrlMappingInfo instances to the given URI and HTTP method
uri - The URI to matchhttpMethod - The HTTP method (GET,POST,PUT,DELETE etc.)Match all possible UrlMappingInfo instances to the given URI and HTTP method
uri - The URI to matchhttpMethod - The HTTP method (GET,POST,PUT,DELETE etc.)version - The version of the APIMatch all possible UrlMappingInfo instances to the given URI and HTTP method
uri - The URI to matchhttpMethod - The HTTP method (GET,POST,PUT,DELETE etc.)Match all possible UrlMappingInfo instances to the given URI and HTTP method
uri - The URI to matchhttpMethod - The HTTP method (GET,POST,PUT,DELETE etc.)version - The versionMatch and return the first UrlMappingInfo instance possible
responseCode - The responseCode to matchMatch and return for first UrlMappingInfo for the give response code and exception
responseCode - The response codee - The exception