JavaScript is disabled on your browser.
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
A
absoluteLinks
- Property in
AbstractLinkingRenderer
absoluteLinks
- Property in
AbstractVndErrorRenderer
AbstractIncludeExcludeRenderer
- Class in
grails.rest.render
Abstract class for implementing renderers that include/exclude certain properties
AbstractIncludeExcludeRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
AbstractIncludeExcludeRenderer
AbstractLinkingRenderer
- Class in
grails.rest.render.util
Abstract base class for HAL renderers
AbstractLinkingRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
AbstractLinkingRenderer
AbstractRenderContext
- Class in
grails.rest.render
Abstract implementation of RenderContext
AbstractRenderContext()
- Constructor in
AbstractRenderContext
AbstractRenderer
- Class in
grails.rest.render
Abstract implementation of the
Renderer
interface
AbstractRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
AbstractRenderer
AbstractVndErrorRenderer
- Class in
grails.rest.render.errors
Abstract super type for Vnd.Error renderers
AbstractVndErrorRenderer()
- Constructor in
AbstractVndErrorRenderer
addConstructor(org.codehaus.groovy.ast.ClassNode, org.codehaus.groovy.ast.ClassNode, boolean)
- Method in
ResourceTransform
addContainerRenderer(java.lang.Class, grails.rest.render.Renderer)
- Method in
DefaultRendererRegistry
addContainerRenderer(java.lang.Class, grails.rest.render.Renderer)
- Method in
RendererRegistry
Adds a container renderer
addDefaultRenderer(Renderer<Object>)
- Method in
DefaultRendererRegistry
addDefaultRenderer(Renderer<Object>)
- Method in
RendererRegistry
Adds a default renderer, which are fall backs if the type is not known
addLinkingMethods(org.codehaus.groovy.ast.ClassNode)
- Method in
LinkableTransform
addRenderer(Renderer<T>)
- Method in
DefaultRendererRegistry
addRenderer(Renderer<T>)
- Method in
RendererRegistry
Adds a new renderer
allowedMethods
- Property in
RestfulController
applyModel(grails.rest.render.RenderContext, java.lang.Object)
- Method in
DefaultHtmlRenderer
ARGUMENT_STATUS
- Field in
ResourceTransform
arguments
- Property in
AbstractRenderContext
arguments
- Property in
ServletRenderContext
ATOM_DATE_FORMAT
- Field in
AtomRenderer
ATOM_NAMESPACE
- Field in
AtomRenderer
AtomCollectionRenderer
- Class in
grails.rest.render.atom
An Atom XML renderer for a collection of objects
AtomCollectionRenderer(java.lang.Class)
- Constructor in
AtomCollectionRenderer
AtomRenderer
- Class in
grails.rest.render.atom
Renders output in Atom format (http://tools.ietf.org/html/rfc4287)
AtomRenderer(Class<T>)
- Constructor in
AtomRenderer
ATTR_NAMESPACE
- Field in
ResourceTransform
ATTR_READY_ONLY
- Field in
ResourceTransform
ATTR_RESPONSE_FORMATS
- Field in
ResourceTransform
ATTR_SUPER_CLASS
- Field in
ResourceTransform
ATTR_URI
- Field in
ResourceTransform
AUTOWIRED_CLASS_NODE
- Field in
ResourceTransform
B
C
clazz
- Property in
DefaultRendererRegistry.ContainerRendererCacheKey
clazz
- Property in
DefaultRendererRegistry.RendererCacheKey
collectionName
- Property in
HalJsonRenderer
componentType
- Property in
AtomCollectionRenderer
componentType
- Property in
HalJsonCollectionRenderer
componentType
- Property in
HalXmlCollectionRenderer
componentType
- Property in
JsonCollectionRenderer
componentType
- Property in
XmlCollectionRenderer
CONSTANT_STATUS
- Field in
ResourceTransform
ContainerRenderer
- Interface in
grails.rest.render
A container a renderer is a render that renders a container of objects (Example: List of Book instances)
containerType
- Property in
DefaultRendererRegistry.ContainerRendererCacheKey
contentType
- Property in
Link
The content type of the linked resource
countResources()
- Method in
RestfulController
Counts all of resources
create()
- Method in
RestfulController
Displays a form to create a new resource
createCacheKey(java.lang.Class, grails.web.mime.MimeType)
- Method in
DefaultRendererRegistry
createLink(Map<String, Object>)
- Method in
Link
Creates a link for the given arguments
createResource()
- Method in
RestfulController
Creates a new instance of the resource.
D
dataBindingSourceRegistry
- Property in
HalJsonRenderer
dateToStringConverter
- Property in
HalJsonRenderer
DEFAULT_ATOM_MIME_TYPES
- Field in
AtomRenderer
DEFAULT_EXCLUDES
- Field in
AbstractLinkingRenderer
DefaultHtmlRenderer
- Class in
org.grails.plugins.web.rest.render.html
A default renderer for HTML that returns an appropriate model
DefaultHtmlRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
DefaultHtmlRenderer
DefaultJsonRenderer
- Class in
org.grails.plugins.web.rest.render.json
Default renderer for JSON
DefaultJsonRenderer(Class<T>, org.grails.web.gsp.io.GrailsConventionGroovyPageLocator, grails.rest.render.RendererRegistry)
- Constructor in
DefaultJsonRenderer
DefaultRendererRegistry
- Class in
org.grails.plugins.web.rest.render
Default implementation of the RendererRegistry interface
DefaultRendererRegistry.ContainerRendererCacheKey
- Class in
org.grails.plugins.web.rest.render
DefaultRendererRegistry.ContainerRendererCacheKey()
- Constructor in
DefaultRendererRegistry.ContainerRendererCacheKey
DefaultRendererRegistry.RendererCacheKey
- Class in
org.grails.plugins.web.rest.render
DefaultRendererRegistry.RendererCacheKey()
- Constructor in
DefaultRendererRegistry.RendererCacheKey
DefaultRendererRegistry()
- Constructor in
DefaultRendererRegistry
DefaultXmlRenderer
- Class in
org.grails.plugins.web.rest.render.xml
Default renderer for XML responses
DefaultXmlRenderer(Class<T>, org.grails.web.gsp.io.GrailsConventionGroovyPageLocator, grails.rest.render.RendererRegistry)
- Constructor in
DefaultXmlRenderer
delete()
- Method in
RestfulController
Deletes a resource for the given id
deleteResource(T)
- Method in
RestfulController
Deletes a resource
DEPRECATED_ATTRIBUTE
- Field in
AbstractLinkingRenderer
deprecated
- Property in
Link
Whether the link is deprecated
doWithSpring()
- Method in
RestResponderGrailsPlugin
E
edit()
- Method in
RestfulController
EMBEDDED_ATTRIBUTE
- Field in
HalJsonRenderer
encoding
- Property in
AbstractLinkingRenderer
encoding
- Property in
AbstractVndErrorRenderer
encoding
- Property in
DefaultJsonRenderer
encoding
- Property in
DefaultXmlRenderer
ENTRY_TAG
- Field in
AtomRenderer
ERROR_TAG
- Field in
VndErrorXmlRenderer
ERRORS_TAG
- Field in
VndErrorXmlRenderer
errorsHttpStatus
- Property in
DefaultJsonRenderer
excludes
- Property in
AbstractIncludeExcludeRenderer
excludes
- Property in
AbstractRenderContext
excludes
- Property in
JsonRenderer
The properties to be excluded
excludes
- Property in
XmlRenderer
The properties to be excluded
excludesProperty(java.lang.Object, java.lang.String)
- Method in
AbstractIncludeExcludeRenderer
excludesProperty(java.lang.Object, java.lang.String)
- Method in
JsonRenderer.1
excludesProperty(java.lang.Object, java.lang.String)
- Method in
JsonRenderer.2
excludesProperty(java.lang.Object, java.lang.String)
- Method in
XmlRenderer.1
excludesProperty(java.lang.Object, java.lang.String)
- Method in
XmlRenderer.2
F
FEED_TAG
- Field in
AtomRenderer
findContainerRenderer(grails.web.mime.MimeType, Class<C>, T)
- Method in
DefaultRendererRegistry
findContainerRenderer(grails.web.mime.MimeType, Class<C>, T)
- Method in
RendererRegistry
Finds a renderer for a container (List, Errors, Map etc.) for another object
findRenderer(grails.web.mime.MimeType, T)
- Method in
DefaultRendererRegistry
findRenderer(grails.web.mime.MimeType, T)
- Method in
RendererRegistry
Finds a renderer
formatAtomDate(java.util.Date)
- Method in
AtomRenderer
formatDateCreated(java.lang.Object)
- Method in
AtomRenderer
formatLastUpdated(java.lang.Object)
- Method in
AtomRenderer
formats()
- Method in
Resource
Returns:
The allowed response formats
FOUR_SPACES
- Field in
VndErrorJsonRenderer
G
generateIdForURI(java.lang.String, java.util.Date, java.lang.Object)
- Method in
AtomRenderer
getAcceptMimeType()
- Method in
RenderContext
Returns:
Returns the mime type accepted by the client or null if non specified
getAcceptMimeType()
- Method in
ServletRenderContext
getActionName()
- Method in
RenderContext
Returns:
The current action name
getActionName()
- Method in
ServletRenderContext
getArguments()
- Method in
RenderContext
Returns:
Arguments passed by the user
getClassMessageArg()
- Method in
RestfulController
getComponentType()
- Method in
AbstractVndErrorRenderer
getComponentType()
- Method in
ContainerRenderer
Returns:
The underlying type wrapped by the container.
getControllerName()
- Method in
RenderContext
Returns:
The current controller name
getControllerName()
- Method in
ServletRenderContext
getControllerNamespace()
- Method in
RenderContext
Returns:
The current controller name
getControllerNamespace()
- Method in
ServletRenderContext
getExcludes()
- Method in
RenderContext
Which properties should be excluded from rendering
getHttpMethod()
- Method in
RenderContext
Returns:
The HTTP method
getHttpMethod()
- Method in
ServletRenderContext
getIncludes()
- Method in
RenderContext
Which properties should be included in rendering
getLinksForObject(java.lang.Object)
- Method in
AbstractLinkingRenderer
getLinkTitle(org.grails.datastore.mapping.model.PersistentEntity, java.util.Locale)
- Method in
AbstractLinkingRenderer
getLocale()
- Method in
RenderContext
Returns:
The locale
getLocale()
- Method in
ServletRenderContext
getMimeTypes()
- Method in
DefaultHtmlRenderer
getMimeTypes()
- Method in
HalJsonRenderer.1
getModelAndView()
- Method in
ServletRenderContext
getObjectId(java.lang.Object)
- Method in
AbstractVndErrorRenderer
getObjectId(org.grails.datastore.mapping.model.PersistentEntity, java.lang.Object)
- Method in
AtomRenderer
getObjectToBind()
- Method in
RestfulController
The object that can be bound to a domain instance.
getProxyHandler()
- Method in
RestResponder
getRendererRegistry()
- Method in
RestResponder
getResourcePath()
- Method in
RenderContext
Returns:
The path the the resource
getResourcePath()
- Method in
ServletRenderContext
getResourceTitle(java.lang.String, java.util.Locale)
- Method in
AbstractLinkingRenderer
getTargetClassForContainer(java.lang.Class, java.lang.Object)
- Method in
DefaultRendererRegistry
getTargetType()
- Method in
AbstractVndErrorRenderer
getTargetType()
- Method in
DefaultHtmlRenderer
getTargetType()
- Method in
HalJsonRenderer.1
getTargetType()
- Method in
Renderer
Returns:
The target type
getTrait()
- Method in
RestResponderTraitInjector
getViewName()
- Method in
RenderContext
Returns:
The view name to use
getViewName()
- Method in
ServletRenderContext
getWriter()
- Method in
RenderContext
Returns:
The writer to render to
getWriter()
- Method in
ServletRenderContext
grailsApplication
- Property in
JsonRenderer
grailsApplication
- Property in
RestResponderGrailsPlugin
grailsApplication
- Property in
XmlRenderer
groovyPageLocator
- Property in
AbstractLinkingRenderer
groovyPageLocator
- Property in
DefaultJsonRenderer
groovyPageLocator
- Property in
DefaultRendererRegistry
groovyPageLocator
- Property in
DefaultXmlRenderer
H
HalJsonCollectionRenderer
- Class in
grails.rest.render.hal
A HAL JSON renderer for a collection of objects
HalJsonCollectionRenderer(java.lang.Class, grails.web.mime.MimeType)
- Constructor in
HalJsonCollectionRenderer
HalJsonRenderer
- Class in
grails.rest.render.hal
Renders domain instances in HAL JSON format (see http://tools.ietf.org/html/draft-kelly-json-hal-05)
HalJsonRenderer.1
- Class in
grails.rest.render.hal
HalJsonRenderer.1()
- Constructor in
HalJsonRenderer.1
HalJsonRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
HalJsonRenderer
HalXmlCollectionRenderer
- Class in
grails.rest.render.hal
A HAL XML renderer for a collection of objects
HalXmlCollectionRenderer(java.lang.Class, grails.web.mime.MimeType)
- Constructor in
HalXmlCollectionRenderer
HalXmlRenderer
- Class in
grails.rest.render.hal
Renders domain instances in HAL XML format (see http://stateless.co/hal_specification.html)
HalXmlRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
HalXmlRenderer
handleReadOnly()
- Method in
RestfulController
handles the request for write methods (create, edit, update, save, delete) when controller is in read only mode
HREF_ATTRIBUTE
- Field in
AbstractLinkingRenderer
HREF_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
href
- Property in
Link
The link's href
HREFLANG_ATTRIBUTE
- Field in
AbstractLinkingRenderer
hreflang
- Property in
Link
The language of the linked resource
I
ID_DATE_FORMAT
- Field in
AtomRenderer
ID_TAG
- Field in
AtomRenderer
includeExcludeSupport
- Property in
AbstractIncludeExcludeRenderer
includes
- Property in
AbstractIncludeExcludeRenderer
includes
- Property in
AbstractRenderContext
includes
- Property in
JsonRenderer
The properties to be included
includes
- Property in
XmlRenderer
The properties to be included
includesProperty(java.lang.Object, java.lang.String)
- Method in
AbstractIncludeExcludeRenderer
includesProperty(java.lang.Object, java.lang.String)
- Method in
JsonRenderer.1
includesProperty(java.lang.Object, java.lang.String)
- Method in
JsonRenderer.2
includesProperty(java.lang.Object, java.lang.String)
- Method in
XmlRenderer.1
includesProperty(java.lang.Object, java.lang.String)
- Method in
XmlRenderer.2
index(java.lang.Integer)
- Method in
RestfulController
Lists all resources up to the given maximum
initialize()
- Method in
DefaultRendererRegistry
initialize()
- Method in
HalJsonRenderer
isContainerType(Class<?>)
- Method in
DefaultRendererRegistry
isContainerType(Class<?>)
- Method in
RendererRegistry
Whether the specified class is a container (list, map etc.)
isDomainResource(java.lang.Class)
- Method in
AbstractLinkingRenderer
J
JsonCollectionRenderer
- Class in
grails.rest.render.json
A JSON renderer for a collection of objects
JsonCollectionRenderer(java.lang.Class, grails.web.mime.MimeType)
- Constructor in
JsonCollectionRenderer
JsonRenderer
- Class in
grails.rest.render.json
A JSON renderer that allows including / excluding properties
JsonRenderer.1
- Class in
grails.rest.render.json
JsonRenderer.1()
- Constructor in
JsonRenderer.1
JsonRenderer.2
- Class in
grails.rest.render.json
JsonRenderer.2()
- Constructor in
JsonRenderer.2
JsonRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
JsonRenderer
K
L
Link
- Class in
grails.rest
Represents a Link in a RESTful resource.
Link(java.lang.String, java.lang.String)
- Constructor in
Link
LINK_METHOD
- Field in
LinkableTransform
LINK_TAG
- Field in
HalXmlRenderer
LINK_TAG
- Field in
VndErrorXmlRenderer
Linkable
- Annotation Type in
grails.rest
A transform that makes it possible to attach
Link
instances to any class.
LinkableTransform
- Class in
org.grails.plugins.web.rest.transform
Implementation of the Linkable transform
LinkableTransform()
- Constructor in
LinkableTransform
linkGenerator
- Property in
AbstractLinkingRenderer
linkGenerator
- Property in
AbstractVndErrorRenderer
LINKS_ATTRIBUTE
- Field in
HalJsonRenderer
LINKS_ATTRIBUTE
- Field in
VndErrorJsonRenderer
LINKS_METHOD
- Field in
LinkableTransform
listAllResources(java.util.Map)
- Method in
RestfulController
List all of resource based on parameters
loadBefore
- Property in
RestResponderGrailsPlugin
LOGREF_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
M
mappingContext
- Property in
AbstractLinkingRenderer
MESSAGE_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
messageSource
- Property in
AbstractLinkingRenderer
messageSource
- Property in
AbstractVndErrorRenderer
MIME_TYPE
- Field in
AtomRenderer
MIME_TYPE
- Field in
HalJsonRenderer
MIME_TYPE
- Field in
HalXmlRenderer
MIME_TYPE
- Field in
VndErrorJsonRenderer
MIME_TYPE
- Field in
VndErrorXmlRenderer
mimeType
- Property in
DefaultRendererRegistry.ContainerRendererCacheKey
mimeType
- Property in
DefaultRendererRegistry.RendererCacheKey
mimeTypes
- Property in
AbstractRenderer
mimeTypes
- Field in
DefaultHtmlRenderer
mimeTypes
- Property in
DefaultJsonRenderer
mimeTypes
- Property in
DefaultXmlRenderer
mimeTypes
- Property in
VndErrorJsonRenderer
mimeTypes
- Property in
VndErrorXmlRenderer
modelSuffix
- Property in
DefaultRendererRegistry
N
namedConfiguration
- Property in
DefaultJsonRenderer
namedConfiguration
- Property in
DefaultXmlRenderer
namespace()
- Method in
Resource
Returns:
The namespace of the resource.
notFound()
- Method in
RestfulController
O
observe
- Property in
RestResponderGrailsPlugin
onChange(Map<String, Object>)
- Method in
RestResponderGrailsPlugin
P
PARAMS_VARIABLE
- Field in
ResourceTransform
patch()
- Method in
RestfulController
Updates a resource for the given id
PATH_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
prettyPrint
- Property in
AbstractLinkingRenderer
prettyPrint
- Property in
AbstractVndErrorRenderer
proxyHandler
- Property in
AbstractLinkingRenderer
proxyHandler
- Property in
DefaultHtmlRenderer
proxyHandler
- Property in
DefaultRendererRegistry
proxyHandler
- Property in
JsonRenderer
proxyHandler
- Property in
XmlRenderer
PUBLISHED_TAG
- Field in
AtomRenderer
Q
queryForResource(java.io.Serializable)
- Method in
RestfulController
Queries for a resource for the given id
R
readOnly()
- Method in
Resource
Returns:
Whether this is a read-only resource (one that doesn't allow DELETE, POST, PUT or PATCH requests)
readOnly
- Property in
RestfulController
REDIRECT_METHOD
- Field in
ResourceTransform
registerCustomConverter()
- Method in
JsonRenderer
registerCustomConverter()
- Method in
XmlRenderer
registerCustomMarshaller(org.grails.web.converters.marshaller.ObjectMarshaller)
- Method in
JsonRenderer
registerCustomMarshaller(org.grails.web.converters.marshaller.ObjectMarshaller)
- Method in
XmlRenderer
registryResourceControllers(grails.core.GrailsApplication)
- Method in
RestResponderGrailsPlugin
rel
- Property in
Link
The link relationship
RELATIONSHIP_ALTERNATE
- Field in
AtomRenderer
RELATIONSHIP_ATTRIBUTE
- Field in
HalXmlRenderer
RELATIONSHIP_SELF
- Field in
AbstractLinkingRenderer
render(T, grails.rest.render.RenderContext)
- Method in
AbstractLinkingRenderer
render(T, grails.rest.render.RenderContext)
- Method in
DefaultHtmlRenderer
render(T, grails.rest.render.RenderContext)
- Method in
DefaultJsonRenderer
render(T, grails.rest.render.RenderContext)
- Method in
DefaultXmlRenderer
RENDER_METHOD
- Field in
ResourceTransform
render(T, grails.rest.render.RenderContext)
- Method in
Renderer
Renders the object
render(org.springframework.validation.Errors, grails.rest.render.RenderContext)
- Method in
VndErrorJsonRenderer
render(org.springframework.validation.Errors, grails.rest.render.RenderContext)
- Method in
VndErrorXmlRenderer
RenderContext
- Interface in
grails.rest.render
Passed to a renderer to provide context information
renderEmbeddedAttributes(groovy.json.StreamingJsonBuilder$StreamingJsonDelegate, java.lang.Object, grails.rest.render.RenderContext, grails.web.mime.MimeType)
- Method in
HalJsonRenderer
Renderer
- Interface in
grails.rest.render
Interface for class that render RESTful responses to implement
RendererRegistry
- Interface in
grails.rest.render
Authors:
Graeme Rocher
rendererRegistry
- Property in
AbstractLinkingRenderer
rendererRegistry
- Property in
DefaultJsonRenderer
rendererRegistry
- Property in
DefaultXmlRenderer
renderInternal(T, grails.rest.render.RenderContext)
- Method in
AbstractLinkingRenderer
renderInternal(T, grails.rest.render.RenderContext)
- Method in
AtomRenderer
renderInternal(T, grails.rest.render.RenderContext)
- Method in
HalJsonRenderer
renderInternal(T, grails.rest.render.RenderContext)
- Method in
HalXmlRenderer
renderJson(grails.converters.JSON, grails.rest.render.RenderContext)
- Method in
DefaultJsonRenderer
renderJson(grails.converters.JSON, grails.rest.render.RenderContext)
- Method in
JsonCollectionRenderer
renderJson(grails.converters.JSON, grails.rest.render.RenderContext)
- Method in
JsonRenderer
renderXml(grails.converters.XML, grails.rest.render.RenderContext)
- Method in
DefaultXmlRenderer
Subclasses should override to customize XML response rendering
renderXml(grails.converters.XML, grails.rest.render.RenderContext)
- Method in
XmlCollectionRenderer
renderXml(grails.converters.XML, grails.rest.render.RenderContext)
- Method in
XmlRenderer
resolveLogRef(java.lang.Object, org.springframework.validation.ObjectError)
- Method in
AbstractVndErrorRenderer
Resolve the 'logref' attribute for the error
resolveModelVariableName(java.lang.Object)
- Method in
DefaultHtmlRenderer
Resource
- Annotation Type in
grails.rest
Meta Annotation to applied to a domain class if it is a REST resource
RESOURCE_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
RESOURCE_LINKS_FIELD
- Field in
LinkableTransform
resource
- Property in
RestfulController
RESOURCE_TAG
- Field in
HalXmlRenderer
resourceClassName
- Property in
RestfulController
resourceName
- Property in
RestfulController
ResourceTransform
- Class in
org.grails.plugins.web.rest.transform
The Resource transform automatically exposes a domain class as a RESTful resource.
ResourceTransform()
- Constructor in
ResourceTransform
RESPOND_METHOD
- Field in
ResourceTransform
respond(java.lang.Object, java.util.Map)
- Method in
RestResponder
The respond method will attempt to delivery an appropriate response for the requested response format and value.
RestfulController
- Class in
grails.rest
Base class that can be extended to get the basic CRUD operations needed for a RESTful API.
RestfulController(Class<T>, boolean)
- Constructor in
RestfulController
RestResponder
- Trait in
grails.artefact.controller
Authors:
Jeff Brown
RestResponderGrailsPlugin
- Class in
org.grails.plugins.web.rest.plugin
Since:
2.3
RestResponderGrailsPlugin()
- Constructor in
RestResponderGrailsPlugin
RestResponderTraitInjector
- Class in
grails.compiler.traits
Authors:
Jeff Brown
RestResponderTraitInjector()
- Constructor in
RestResponderTraitInjector
S
save()
- Method in
RestfulController
Saves a resource
saveResource(T)
- Method in
RestfulController
Saves a resource
ServletRenderContext
- Class in
org.grails.plugins.web.rest.render
RenderContext for the servlet environment
ServletRenderContext(org.grails.web.servlet.mvc.GrailsWebRequest, Map<String, Object>)
- Constructor in
ServletRenderContext
setCompilationUnit(org.codehaus.groovy.control.CompilationUnit)
- Method in
ResourceTransform
setContentType(java.lang.String)
- Method in
RenderContext
Sets the content type of the rendered response
setContentType(java.lang.String)
- Method in
ServletRenderContext
setDateToStringConverter(Converter<Date, String>)
- Method in
HalJsonRenderer
setModel(java.util.Map)
- Method in
RenderContext
The model to use for the response
setModel(java.util.Map)
- Method in
ServletRenderContext
setProxyHandler(grails.core.support.proxy.ProxyHandler)
- Method in
RestResponder
setRendererRegistry(grails.rest.render.RendererRegistry)
- Method in
RestResponder
setRenderers(grails.rest.render.Renderer)
- Method in
DefaultRendererRegistry
setResourcePath(java.lang.String)
- Method in
ServletRenderContext
setStatus(org.springframework.http.HttpStatus)
- Method in
RenderContext
Parameters:
status
- The status to set
setStatus(org.springframework.http.HttpStatus)
- Method in
ServletRenderContext
setViewName(java.lang.String)
- Method in
RenderContext
The view to use for the response
setViewName(java.lang.String)
- Method in
ServletRenderContext
shouldIncludeProperty(grails.rest.render.RenderContext, java.lang.Object, java.lang.String)
- Method in
AbstractIncludeExcludeRenderer
show()
- Method in
RestfulController
Shows a single resource
startResourceTag(org.grails.web.xml.XMLStreamWriter, java.lang.String, java.util.Locale, java.lang.String)
- Method in
HalXmlRenderer
startResourceTagForCurrentPath(grails.rest.render.RenderContext, org.grails.web.xml.XMLStreamWriter)
- Method in
HalXmlRenderer
suffix
- Property in
DefaultHtmlRenderer
superClass()
- Method in
Resource
Returns:
The super class to use for the generated controller class
T
targetType
- Property in
AbstractRenderer
targetType
- Field in
DefaultHtmlRenderer
targetType
- Property in
DefaultJsonRenderer
targetType
- Property in
DefaultXmlRenderer
TEMPLATED_ATTRIBUTE
- Field in
AbstractLinkingRenderer
templated
- Property in
Link
Whether the link is a URI template
TITLE_ATTRIBUTE
- Field in
AbstractLinkingRenderer
title
- Property in
Link
The Human readable title of the resource
TYPE_ATTRIBUTE
- Field in
AbstractLinkingRenderer
U
update()
- Method in
RestfulController
Updates a resource for the given id
UPDATED_TAG
- Field in
AtomRenderer
updateResource(T)
- Method in
RestfulController
Updates a resource
uri()
- Method in
Resource
Returns:
The URI of the resource.
V
version
- Property in
RestResponderGrailsPlugin
visit(org.codehaus.groovy.ast.ASTNode, org.codehaus.groovy.control.SourceUnit)
- Method in
LinkableTransform
visit(org.codehaus.groovy.ast.ASTNode, org.codehaus.groovy.control.SourceUnit)
- Method in
ResourceTransform
VndErrorJsonRenderer
- Class in
grails.rest.render.errors
A JSON renderer that renders errors in in the Vnd.Error format (see https://github.com/blongden/vnd.error)
VndErrorJsonRenderer()
- Constructor in
VndErrorJsonRenderer
VndErrorXmlRenderer
- Class in
grails.rest.render.errors
A renderer that renders errors in in the Vnd.Error format (see https://github.com/blongden/vnd.error)
VndErrorXmlRenderer()
- Constructor in
VndErrorXmlRenderer
W
wasWrittenTo()
- Method in
RenderContext
Returns true if the getWriter() method was called
wasWrittenTo()
- Method in
ServletRenderContext
webRequest
- Property in
ServletRenderContext
writeAssociationLinks(grails.rest.render.RenderContext, java.lang.Object, java.util.Locale, java.lang.Object, org.grails.datastore.mapping.model.PersistentEntity, groovy.lang.MetaClass)
- Method in
AbstractLinkingRenderer
writeDomain(grails.rest.render.RenderContext, groovy.lang.MetaClass, org.grails.datastore.mapping.model.PersistentEntity, java.lang.Object, java.lang.Object)
- Method in
AbstractLinkingRenderer
Writes a domain instance
writeDomainProperty(java.lang.Object, java.lang.String, java.lang.Object)
- Method in
AbstractLinkingRenderer
writeDomainProperty(java.lang.Object, java.lang.String, java.lang.Object)
- Method in
HalJsonRenderer
writeDomainProperty(java.lang.Object, java.lang.String, java.lang.Object)
- Method in
HalXmlRenderer
writeDomainWithEmbeddedAndLinks(org.grails.datastore.mapping.model.PersistentEntity, java.lang.Object, grails.rest.render.RenderContext, grails.converters.XML, java.util.Set, boolean)
- Method in
AtomRenderer
writeDomainWithEmbeddedAndLinks(grails.rest.render.RenderContext, java.lang.Class, java.lang.Object, groovy.json.StreamingJsonBuilder$StreamingJsonDelegate, java.util.Locale, grails.web.mime.MimeType, java.util.Set, java.util.Stack)
- Method in
HalJsonRenderer
writeDomainWithEmbeddedAndLinks(org.grails.datastore.mapping.model.PersistentEntity, java.lang.Object, grails.rest.render.RenderContext, grails.converters.XML, java.util.Set)
- Method in
HalXmlRenderer
writeExtraLinks(java.lang.Object, java.util.Locale, java.lang.Object)
- Method in
AbstractLinkingRenderer
writeLink(grails.rest.Link, java.util.Locale, java.lang.Object)
- Method in
AbstractLinkingRenderer
writeLink(grails.rest.Link, java.util.Locale, java.lang.Object)
- Method in
HalJsonRenderer
writeLink(grails.rest.Link, java.util.Locale, java.lang.Object)
- Method in
HalXmlRenderer
writeLinkForCurrentPath(grails.rest.render.RenderContext, grails.web.mime.MimeType, groovy.json.StreamingJsonBuilder$StreamingJsonDelegate)
- Method in
HalJsonRenderer
writeLinks(grails.rest.render.RenderContext, groovy.lang.MetaClass, java.lang.Object, org.grails.datastore.mapping.model.PersistentEntity, java.util.Locale, grails.web.mime.MimeType, groovy.json.StreamingJsonBuilder$StreamingJsonDelegate, boolean)
- Method in
HalJsonRenderer
writeSimpleObject(java.lang.Object, grails.rest.render.RenderContext, groovy.json.StreamingJsonBuilder$StreamingJsonDelegate)
- Method in
HalJsonRenderer
writeSimpleObjectAndLink(java.lang.Object, grails.rest.render.RenderContext, groovy.json.StreamingJsonBuilder$StreamingJsonDelegate, grails.web.mime.MimeType)
- Method in
HalJsonRenderer
X
XmlCollectionRenderer
- Class in
grails.rest.render.xml
A XML renderer for a collection of objects
XmlCollectionRenderer(java.lang.Class, grails.web.mime.MimeType)
- Constructor in
XmlCollectionRenderer
XMLNS_ATTRIBUTE
- Field in
AtomRenderer
XmlRenderer
- Class in
grails.rest.render.xml
An XML renderer that allows including / excluding properties
XmlRenderer.1
- Class in
grails.rest.render.xml
XmlRenderer.1()
- Constructor in
XmlRenderer.1
XmlRenderer.2
- Class in
grails.rest.render.xml
XmlRenderer.2()
- Constructor in
XmlRenderer.2
XmlRenderer(Class<T>, grails.web.mime.MimeType)
- Constructor in
XmlRenderer
Y
Z
_
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
Groovy Documentation