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

org.codehaus.groovy.grails.plugins.web.api
[Java] Class ControllersApi

java.lang.Object
  org.codehaus.groovy.grails.plugins.web.api.CommonWebApi
      org.codehaus.groovy.grails.plugins.web.api.ControllersApi

@SuppressWarnings("rawtypes")
public class ControllersApi
extends CommonWebApi

API for each controller in a Grails application.

Authors:
Graeme Rocher
Since:
2.0

Field Summary
protected static java.lang.String BIND_DATA_METHOD

protected static java.lang.String RENDER_METHOD_NAME

protected static java.lang.String SLASH

protected BindDynamicMethod bind

protected ForwardMethod forwardMethod

protected RedirectDynamicMethod redirect

protected RenderDynamicMethod render

protected WithFormMethod withFormMethod

 
Constructor Summary
ControllersApi()

ControllersApi(GrailsPluginManager pluginManager)

 
Method Summary
java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args)

java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.List disallowed)

java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.List disallowed, java.lang.String filter)

java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.Map includeExclude)

java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.Map includeExclude, java.lang.String filter)

java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.lang.String filter)

java.lang.Object chain(java.lang.Object instance, java.util.Map args)

Invokes the chain method for the given arguments
java.lang.String forward(java.lang.Object instance, java.util.Map params)

Forwards a request for the given parameters using the RequestDispatchers forward method
java.lang.String getActionUri(java.lang.Object instance)

Returns the URI of the currently executing action
protected BindDynamicMethod getBindMethod()

java.util.Map getChainModel(java.lang.Object instance)

Obtains the chain model which is used to chain request attributes from one request to the next via flash scope
java.lang.String getControllerUri(java.lang.Object instance)

Returns the URI of the currently executing controller
org.springframework.validation.Errors getErrors(java.lang.Object instance)

Obtains the errors instance for the current controller
protected ForwardMethod getForwardMethod()

org.springframework.web.servlet.ModelAndView getModelAndView(java.lang.Object instance)

Obtains the ModelAndView for the currently executing controller
protected RedirectDynamicMethod getRedirectMethod()

protected RenderDynamicMethod getRenderMethod()

static org.springframework.context.ApplicationContext getStaticApplicationContext()

java.lang.String getTemplateUri(java.lang.Object instance, java.lang.String name)

Obtains a URI of a template by name
java.lang.String getViewUri(java.lang.Object instance, java.lang.String name)

Obtains a URI of a view by name
protected WithFormMethod getWithFormMethod()

boolean hasErrors(java.lang.Object instance)

Return true if there are an errors
void header(java.lang.Object instance, java.lang.String headerName, java.lang.Object headerValue)

Sets a response header for the given name and value
static void initialize(java.lang.Object instance)

Constructor used by controllers
protected java.lang.Object invokeBindData(java.lang.Object instance, java.lang.Object... args)

protected java.lang.Object invokeRender(java.lang.Object instance, java.lang.Object... args)

java.lang.Object redirect(java.lang.Object instance, java.util.Map args)

Redirects for the given arguments.
java.lang.Object render(java.lang.Object instance, java.lang.Object o)

java.lang.Object render(java.lang.Object instance, java.lang.String txt)

java.lang.Object render(java.lang.Object instance, java.util.Map args)

java.lang.Object render(java.lang.Object instance, groovy.lang.Closure c)

java.lang.Object render(java.lang.Object instance, java.util.Map args, groovy.lang.Closure c)

void setErrors(java.lang.Object instance, org.springframework.validation.Errors errors)

Sets the errors instance of the current controller
void setGspEncoding(java.lang.String gspEncoding)

void setLinkGenerator(LinkGenerator linkGenerator)

void setModelAndView(java.lang.Object instance, org.springframework.web.servlet.ModelAndView mav)

Sets the ModelAndView of the current controller
void setRedirectListeners(java.util.Collection redirectListeners)

void setUseJessionId(boolean useJessionId)

java.lang.Object withForm(java.lang.Object instance, groovy.lang.Closure callable)

Used the synchronizer token pattern to avoid duplicate form submissions
 
Methods inherited from class CommonWebApi
currentRequestAttributes, getActionName, getApplicationContext, getControllerName, getFlash, getGrailsApplication, getGrailsAttributes, getParams, getPluginContextPath, getRequest, getResponse, getServletContext, getSession, getWebRequest, setApplicationContext, setGrailsApplication, setServletContext
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

BIND_DATA_METHOD

protected static final java.lang.String BIND_DATA_METHOD

RENDER_METHOD_NAME

protected static final java.lang.String RENDER_METHOD_NAME

SLASH

protected static final java.lang.String SLASH

bind

protected BindDynamicMethod bind

forwardMethod

protected ForwardMethod forwardMethod

redirect

protected RedirectDynamicMethod redirect

render

protected RenderDynamicMethod render

withFormMethod

protected WithFormMethod withFormMethod

 
Constructor Detail

ControllersApi

public ControllersApi()

ControllersApi

public ControllersApi(GrailsPluginManager pluginManager)

 
Method Detail

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args)

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.List disallowed)

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.List disallowed, java.lang.String filter)

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.Map includeExclude)

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.util.Map includeExclude, java.lang.String filter)

bindData

public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object args, java.lang.String filter)

chain

public java.lang.Object chain(java.lang.Object instance, java.util.Map args)
Invokes the chain method for the given arguments
Parameters:
instance - The instance
args - The arguments
Returns:
Result of the redirect call

forward

public java.lang.String forward(java.lang.Object instance, java.util.Map params)
Forwards a request for the given parameters using the RequestDispatchers forward method
Parameters:
instance - The instance
params - The parameters
Returns:
The forwarded URL

getActionUri

public java.lang.String getActionUri(java.lang.Object instance)
Returns the URI of the currently executing action
Returns:
The action URI

getBindMethod

protected BindDynamicMethod getBindMethod()

getChainModel

public java.util.Map getChainModel(java.lang.Object instance)
Obtains the chain model which is used to chain request attributes from one request to the next via flash scope
Returns:
The chainModel

getControllerUri

public java.lang.String getControllerUri(java.lang.Object instance)
Returns the URI of the currently executing controller
Returns:
The controller URI

getErrors

public org.springframework.validation.Errors getErrors(@SuppressWarnings("unused") java.lang.Object instance)
Obtains the errors instance for the current controller
Returns:
The Errors instance

getForwardMethod

protected ForwardMethod getForwardMethod()

getModelAndView

public org.springframework.web.servlet.ModelAndView getModelAndView(@SuppressWarnings("unused") java.lang.Object instance)
Obtains the ModelAndView for the currently executing controller
Returns:
The ModelAndView

getRedirectMethod

protected RedirectDynamicMethod getRedirectMethod()

getRenderMethod

protected RenderDynamicMethod getRenderMethod()

getStaticApplicationContext

public static org.springframework.context.ApplicationContext getStaticApplicationContext()

getTemplateUri

public java.lang.String getTemplateUri(java.lang.Object instance, java.lang.String name)
Obtains a URI of a template by name
Parameters:
name - The name of the template
Returns:
The template URI

getViewUri

public java.lang.String getViewUri(java.lang.Object instance, java.lang.String name)
Obtains a URI of a view by name
Parameters:
name - The name of the view
Returns:
The template URI

getWithFormMethod

protected WithFormMethod getWithFormMethod()

hasErrors

public boolean hasErrors(java.lang.Object instance)
Return true if there are an errors
Returns:
true if there are errors

header

public void header(java.lang.Object instance, java.lang.String headerName, java.lang.Object headerValue)
Sets a response header for the given name and value
Parameters:
instance - The instance
headerName - The header name
headerValue - The header value

initialize

public static void initialize(java.lang.Object instance)
Constructor used by controllers
Parameters:
instance - The instance

invokeBindData

protected java.lang.Object invokeBindData(java.lang.Object instance, java.lang.Object... args)

invokeRender

protected java.lang.Object invokeRender(java.lang.Object instance, java.lang.Object... args)

redirect

public java.lang.Object redirect(java.lang.Object instance, java.util.Map args)
Redirects for the given arguments.
Parameters:
args - The arguments
Returns:
null

render

public java.lang.Object render(java.lang.Object instance, java.lang.Object o)

render

public java.lang.Object render(java.lang.Object instance, java.lang.String txt)

render

public java.lang.Object render(java.lang.Object instance, java.util.Map args)

render

public java.lang.Object render(java.lang.Object instance, groovy.lang.Closure c)

render

public java.lang.Object render(java.lang.Object instance, java.util.Map args, groovy.lang.Closure c)

setErrors

public void setErrors(@SuppressWarnings("unused") java.lang.Object instance, org.springframework.validation.Errors errors)
Sets the errors instance of the current controller
Parameters:
errors - The error instance

setGspEncoding

public void setGspEncoding(java.lang.String gspEncoding)

setLinkGenerator

public void setLinkGenerator(LinkGenerator linkGenerator)

setModelAndView

public void setModelAndView(@SuppressWarnings("unused") java.lang.Object instance, org.springframework.web.servlet.ModelAndView mav)
Sets the ModelAndView of the current controller
Parameters:
mav - The ModelAndView

setRedirectListeners

public void setRedirectListeners(java.util.Collection redirectListeners)

setUseJessionId

public void setUseJessionId(boolean useJessionId)

withForm

public java.lang.Object withForm(java.lang.Object instance, groovy.lang.Closure callable)
Used the synchronizer token pattern to avoid duplicate form submissions
Parameters:
instance - The instance
callable - The closure to execute
Returns:
The result of the closure execution

 

Groovy Documentation