Represents a controller class in Grails.
Modifiers | Name | Description |
---|---|---|
java.lang.String |
ACTION |
The general name to use when referring to action artefacts. |
java.lang.String |
AFTER_INTERCEPTOR |
The name of the after interceptor property. |
java.lang.String |
BEFORE_INTERCEPTOR |
The name of the before interceptor property. |
java.lang.String |
CONTROLLER |
The general name to use when referring to controller artefacts. |
java.lang.String |
INDEX_ACTION |
The name of the index action. |
java.lang.String |
NAMESPACE_PROPERTY |
The name of the namespace property |
java.lang.String |
VIEW |
The general name to use when referring to action view. |
Type Params | Return Type | Name and description |
---|---|---|
|
groovy.lang.Closure |
getAfterInterceptor(groovy.lang.GroovyObject controller) Retrieves the after interceptor for the specified controller instance. |
|
groovy.lang.Closure |
getBeforeInterceptor(groovy.lang.GroovyObject controller) Retrieves the before interceptor for the specified controller instance. |
|
java.util.Set |
getCommandObjectActions() @deprecated This method is deprecated and will be removed in a future version of Grails |
|
java.util.Set |
getCommandObjectClasses() @deprecated This method is deprecated and will be removed in a future version of Grails |
|
java.lang.String |
getDefaultAction() Returns the default action for this Controller. |
|
java.util.Map |
getFlows() |
|
java.lang.String |
getMethodActionName(java.lang.String uri) Returns a closure property name for a specific URI or null if the URI does not map to a closure. |
|
java.lang.String |
getNamespace() @return the namespace of this controller, null if none was specified |
|
java.lang.String[] |
getURIs() Gets the list of all possible URI's available in this controller. |
|
java.lang.String |
getViewByName(java.lang.String closureName) Retrieves the view name for the specified closure name. |
|
java.lang.String |
getViewByURI(java.lang.String uri) Retrieves the view name for the specified URI. |
|
void |
initialize() Initialize the controller class |
|
boolean |
isFlowAction(java.lang.String actionName) Returns true if the given action name is a flow action. |
|
boolean |
isHttpMethodAllowedForAction(groovy.lang.GroovyObject controller, java.lang.String httpMethod, java.lang.String actionName) Checks to see if an action is accessible via a particular http method. |
|
boolean |
isInterceptedAfter(groovy.lang.GroovyObject controller, java.lang.String action) Checks whether the specified action is intercepted after for the specified controller instance. |
|
boolean |
isInterceptedBefore(groovy.lang.GroovyObject controller, java.lang.String action) Checks whether the specified action is intercepted for the specified controller instance. |
|
boolean |
mapsToURI(java.lang.String uri) Tests if a controller maps to a given URI. |
|
void |
registerMapping(java.lang.String actionName) Registers a new mapping onto this controller for the given actionName. |
|
void |
setDefaultActionName(java.lang.String defaultActionName) Sets the name of the default action. |
Methods inherited from class | Name |
---|---|
interface InjectableGrailsClass |
byName, byType, getAvailable |
interface GrailsClass |
getClazz, getFullName, getGrailsApplication, getLogicalPropertyName, getMetaClass, getName, getNaturalName, getPackageName, getPropertyName, getPropertyValue, getPropertyValue, getReference, getReferenceInstance, getShortName, hasProperty, isAbstract, newInstance |
interface GrailsApplicationAware |
setGrailsApplication |
The general name to use when referring to action artefacts.
The name of the after interceptor property.
The name of the before interceptor property.
The general name to use when referring to controller artefacts.
The name of the index action.
The name of the namespace property
The general name to use when referring to action view.
Retrieves the after interceptor for the specified controller instance.
controller
- The controller instanceRetrieves the before interceptor for the specified controller instance.
controller
- The controller instanceReturns the default action for this Controller.
Returns a map of the flows for this controller. A flow is an action that ends with the convention "Flow". The keys in the map are the flow ids which are the text before the "Flow" suffix. For example a flow called "bookFlow" would have a key of "book"
The values within the Map are Groovy closures (
Returns a closure property name for a specific URI or null if the URI does not map to a closure.
uri
- the URI of the request
Gets the list of all possible URI's available in this controller.
Retrieves the view name for the specified closure name.
closureName
- The name of the closureRetrieves the view name for the specified URI.
uri
- the name of URIInitialize the controller class
Returns true if the given action name is a flow action.
actionName
- The name of the actionChecks to see if an action is accessible via a particular http method.
controller
- The instance of the controllerhttpMethod
- The http request methodactionName
- The action to checkChecks whether the specified action is intercepted after for the specified controller instance.
controller
- The controller instanceaction
- The action to checkChecks whether the specified action is intercepted for the specified controller instance.
controller
- The instance of the controlleraction
- The action to checkTests if a controller maps to a given URI.
Registers a new mapping onto this controller for the given actionName.
actionName
- The actionNameSets the name of the default action.
defaultActionName
- The default action name