Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.codehaus.groovy.grails.web.servlet.mvc
[Java] Interface GrailsControllerHelper

public interface GrailsControllerHelper

Processes Grails controller requests and responses.

Authors:
Graeme Rocher
Since:
0.2

Method Summary
GrailsControllerClass getControllerClassByName(java.lang.String className)

Retrieves a controller class for the specified class name
GrailsControllerClass getControllerClassByURI(java.lang.String uri)

Retrieves a GrailsControllerClass by URI.
groovy.lang.GroovyObject getControllerInstance(GrailsControllerClass controllerClass)

Creates a new controller instance for the specified GrailsControllerClass.
GrailsApplicationAttributes getGrailsAttributes()

@return Returns the grails request attributes instance
ServletContext getServletContext()

@return The servlet context instance
java.lang.Object handleAction(groovy.lang.GroovyObject controller, groovy.lang.Closure action, HttpServletRequest request, HttpServletResponse response)

Handles a Controller action.
java.lang.Object handleAction(groovy.lang.GroovyObject controller, groovy.lang.Closure action, HttpServletRequest request, HttpServletResponse response, java.util.Map params)

Handles a Controller action.
ModelAndView handleActionResponse(groovy.lang.GroovyObject controller, java.lang.Object returnValue, java.lang.String closurePropertyName, java.lang.String viewName)

Processes an action response for the specified arguments.
ModelAndView handleURI(java.lang.String uri, GrailsWebRequest webRequest)

Handles a Grails URI.
ModelAndView handleURI(java.lang.String uri, GrailsWebRequest webRequest, java.util.Map params)

Handles a Grails URI
 

Method Detail

getControllerClassByName

public GrailsControllerClass getControllerClassByName(java.lang.String className)
Retrieves a controller class for the specified class name
Parameters:
className
Returns:
The controller class or null

getControllerClassByURI

public GrailsControllerClass getControllerClassByURI(java.lang.String uri)
Retrieves a GrailsControllerClass by URI.
Parameters:
uri - The URI to lookup
Returns:
A GrailsControllerClass

getControllerInstance

public groovy.lang.GroovyObject getControllerInstance(GrailsControllerClass controllerClass)
Creates a new controller instance for the specified GrailsControllerClass.
Parameters:
controllerClass - The GrailsControllerClass
Returns:
A new controller instance

getGrailsAttributes

public GrailsApplicationAttributes getGrailsAttributes()
Returns:
Returns the grails request attributes instance

getServletContext

public ServletContext getServletContext()
Returns:
The servlet context instance

handleAction

public java.lang.Object handleAction(groovy.lang.GroovyObject controller, groovy.lang.Closure action, HttpServletRequest request, HttpServletResponse response)
Handles a Controller action.
Parameters:
action - An action Closure instance
request - The request object
response - The response
Returns:
The action response

handleAction

@SuppressWarnings("rawtypes")
public java.lang.Object handleAction(groovy.lang.GroovyObject controller, groovy.lang.Closure action, HttpServletRequest request, HttpServletResponse response, java.util.Map params)
Handles a Controller action.
Parameters:
action - An action Closure instance
request - The request object
response - The response
params - A Map of controller parameters
Returns:
The action response

handleActionResponse

public ModelAndView handleActionResponse(groovy.lang.GroovyObject controller, java.lang.Object returnValue, java.lang.String closurePropertyName, java.lang.String viewName)
Processes an action response for the specified arguments.
Parameters:
controller - The controller instance
returnValue - The response from the closure
closurePropertyName - The property name of the closure
viewName - The name of the view
Returns:
A ModelAndView object

handleURI

public ModelAndView handleURI(java.lang.String uri, GrailsWebRequest webRequest)
Handles a Grails URI.
Parameters:
uri - The URI to process
webRequest - The GrailsWebRequest
Returns:
A ModelAndView instance

handleURI

@SuppressWarnings("rawtypes")
public ModelAndView handleURI(java.lang.String uri, GrailsWebRequest webRequest, java.util.Map params)
Handles a Grails URI
Parameters:
uri - The URI to processs
webRequest - the GrailsWebRequest instance
params - A map of controller parameters
Returns:
A ModelAndView instance

 

Groovy Documentation