|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.groovy.grails.plugins.web.api.CommonWebApi
org.codehaus.groovy.grails.plugins.web.api.ControllersApi
@java.lang.SuppressWarnings("rawtypes") public class ControllersApi extends CommonWebApi
API for each controller in a Grails application.
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 ForwardMethod |
forwardMethod
|
protected RedirectDynamicMethod |
redirect
|
protected RenderDynamicMethod |
render
|
protected WithFormMethod |
withFormMethod
|
Fields inherited from class CommonWebApi | |
---|---|
RAW_CODEC_NAME |
Constructor Summary | |
ControllersApi()
|
|
ControllersApi(GrailsPluginManager pluginManager)
|
Method Summary | |
---|---|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.List excludes)
|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.List excludes, java.lang.String filter)
|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.Map includeExclude)
|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.lang.String filter)
|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource)
|
java.lang.Object
|
bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.Map includeExclude, java.lang.String filter)
|
void
|
bindData(java.lang.Object instance, java.lang.Class targetType, java.util.Collection collectionToPopulate, javax.servlet.ServletRequest request)
|
void
|
bindData(java.lang.Object instance, java.lang.Class targetType, java.util.Collection collectionToPopulate, CollectionDataBindingSource collectionBindingSource)
|
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 |
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 |
java.lang.reflect.Method
|
getExceptionHandlerMethodFor(java.lang.Object controllerInstance, java.lang.Class exceptionType)
|
org.springframework.web.servlet.ModelAndView
|
getModelAndView(java.lang.Object instance)
Obtains the ModelAndView for the currently executing controller |
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 |
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 |
java.lang.Object
|
initializeCommandObject(java.lang.Object controllerInstance, java.lang.Class type)
Initializes a command object. |
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
|
redirect(java.lang.Object instance, java.lang.Object object)
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 java.lang.Object | |
---|---|
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), 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 |
---|
protected static final java.lang.String BIND_DATA_METHOD
protected static final java.lang.String RENDER_METHOD_NAME
protected static final java.lang.String SLASH
protected ForwardMethod forwardMethod
protected RedirectDynamicMethod redirect
protected RenderDynamicMethod render
protected WithFormMethod withFormMethod
Constructor Detail |
---|
public ControllersApi()
public ControllersApi(GrailsPluginManager pluginManager)
Method Detail |
---|
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.List excludes)
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.List excludes, java.lang.String filter)
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.Map includeExclude)
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.lang.String filter)
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource)
public java.lang.Object bindData(java.lang.Object instance, java.lang.Object target, java.lang.Object bindingSource, java.util.Map includeExclude, java.lang.String filter)
public void bindData(java.lang.Object instance, java.lang.Class targetType, java.util.Collection collectionToPopulate, javax.servlet.ServletRequest request)
public void bindData(java.lang.Object instance, java.lang.Class targetType, java.util.Collection collectionToPopulate, CollectionDataBindingSource collectionBindingSource)
public java.lang.Object chain(java.lang.Object instance, java.util.Map args)
instance
- The instanceargs
- The arguments
public java.lang.String forward(java.lang.Object instance, java.util.Map params)
instance
- The instanceparams
- The parameters
public java.lang.String getActionUri(java.lang.Object instance)
public java.util.Map getChainModel(java.lang.Object instance)
public java.lang.String getControllerUri(java.lang.Object instance)
public org.springframework.validation.Errors getErrors(java.lang.Object instance)
@java.lang.SuppressWarningsif(!Exception.class.isAssignableFrom(exceptionType)) { public java.lang.reflect.Method getExceptionHandlerMethodFor(java.lang.Object controllerInstance, java.lang.Class exceptionType)
public org.springframework.web.servlet.ModelAndView getModelAndView(java.lang.Object instance)
public static org.springframework.context.ApplicationContext getStaticApplicationContext()
public java.lang.String getTemplateUri(java.lang.Object instance, java.lang.String name)
name
- The name of the template
public java.lang.String getViewUri(java.lang.Object instance, java.lang.String name)
name
- The name of the view
public boolean hasErrors(java.lang.Object instance)
public void header(java.lang.Object instance, java.lang.String headerName, java.lang.Object headerValue)
instance
- The instanceheaderName
- The header nameheaderValue
- The header value
public static void initialize(java.lang.Object instance)
instance
- The instance
public java.lang.Object initializeCommandObject(java.lang.Object controllerInstance, java.lang.Class type)
controllerInstance
- The controller instancetype
- The type of the command object
protected java.lang.Object invokeRender(java.lang.Object instance, java.lang.Object... args)
public java.lang.Object redirect(java.lang.Object instance, java.util.Map args)
args
- The arguments
@java.lang.SuppressWarningspublic Object redirect(Object instance,Object object) { public java.lang.Object redirect(java.lang.Object instance, java.lang.Object object)
object
- A domain class
public java.lang.Object render(java.lang.Object instance, java.lang.Object o)
public java.lang.Object render(java.lang.Object instance, java.lang.String txt)
public java.lang.Object render(java.lang.Object instance, java.util.Map args)
public java.lang.Object render(java.lang.Object instance, groovy.lang.Closure c)
public java.lang.Object render(java.lang.Object instance, java.util.Map args, groovy.lang.Closure c)
public void setErrors(java.lang.Object instance, org.springframework.validation.Errors errors)
errors
- The error instance
public void setGspEncoding(java.lang.String gspEncoding)
public void setLinkGenerator(LinkGenerator linkGenerator)
public void setModelAndView(java.lang.Object instance, org.springframework.web.servlet.ModelAndView mav)
mav
- The ModelAndView
public void setRedirectListeners(java.util.Collection redirectListeners)
public void setUseJessionId(boolean useJessionId)
public java.lang.Object withForm(java.lang.Object instance, groovy.lang.Closure callable)
instance
- The instancecallable
- The closure to execute
Groovy Documentation