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
AbstractIncludeExcludeRenderer
- Class in
grails.rest.render
Abstract class for implementing renderers that include/exclude certain properties
AbstractIncludeExcludeRenderer(Class<T>, MimeType)
- Constructor in
AbstractIncludeExcludeRenderer
AbstractLinkingRenderer
- Class in
grails.rest.render.util
Abstract base class for HAL renderers
AbstractLinkingRenderer(Class<T>, MimeType)
- Constructor in
AbstractLinkingRenderer
AbstractRenderContext
- Class in
grails.rest.render
Abstract implementation of RenderContext
AbstractRenderer
- Class in
grails.rest.render
Abstract implementation of the
Renderer
interface
AbstractRenderer(Class<T>, MimeType)
- Constructor in
AbstractRenderer
AbstractVndErrorRenderer
- Class in
grails.rest.render.errors
Abstract super type for Vnd.Error renderers
addConstructor(ClassNode, ClassNode, boolean)
- Method in
ResourceTransform
addContainerRenderer(Class, Renderer)
- Method in
DefaultRendererRegistry
addContainerRenderer(Class, 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(ClassNode)
- Method in
LinkableTransform
addRenderer(Renderer<T>)
- Method in
DefaultRendererRegistry
addRenderer(Renderer<T>)
- Method in
RendererRegistry
Adds a new renderer
applyModel(RenderContext, Object)
- Method in
DefaultHtmlRenderer
ARGUMENT_STATUS
- Field in
ResourceTransform
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(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
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)
countResources()
- Method in
RestfulController
Counts all of resources
create()
- Method in
RestfulController
Displays a form to create a new resource
createCacheKey(Class, 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
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>, MimeType)
- Constructor in
DefaultHtmlRenderer
DefaultJsonRenderer
- Class in
org.grails.plugins.web.rest.render.json
Default renderer for JSON
DefaultJsonRenderer(Class<T>, GrailsConventionGroovyPageLocator, 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.RendererCacheKey
- Class in
org.grails.plugins.web.rest.render
DefaultRendererRegistry()
- Constructor in
DefaultRendererRegistry
DefaultXmlRenderer
- Class in
org.grails.plugins.web.rest.render.xml
Default renderer for XML responses
DefaultXmlRenderer(Class<T>, GrailsConventionGroovyPageLocator, 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
doWithSpring()
- Method in
RestResponderGrailsPlugin
E
edit()
- Method in
RestfulController
EMBEDDED_ATTRIBUTE
- Field in
HalJsonRenderer
ENTRY_TAG
- Field in
AtomRenderer
ERROR_TAG
- Field in
VndErrorXmlRenderer
ERRORS_TAG
- Field in
VndErrorXmlRenderer
excludesProperty(Object, String)
- Method in
AbstractIncludeExcludeRenderer
F
FEED_TAG
- Field in
AtomRenderer
findContainerRenderer(MimeType, Class<C>, T)
- Method in
DefaultRendererRegistry
findContainerRenderer(MimeType, Class<C>, T)
- Method in
RendererRegistry
Finds a renderer for a container (List, Errors, Map etc.) for another object
findRenderer(MimeType, T)
- Method in
DefaultRendererRegistry
findRenderer(MimeType, T)
- Method in
RendererRegistry
Finds a renderer
formatAtomDate(Date)
- Method in
AtomRenderer
formatDateCreated(def)
- Method in
AtomRenderer
formatLastUpdated(def)
- Method in
AtomRenderer
formats()
- Method in
Resource
@default "json", 'xml']
Returns:
The allowed response formats
FOUR_SPACES
- Field in
VndErrorJsonRenderer
G
generateIdForURI(String, Date, Object)
- Method in
AtomRenderer
getAcceptMimeType()
- Method in
RenderContext
@return Returns the mime type accepted by the client or null if non specified
getAcceptMimeType()
- Method in
ServletRenderContext
getActionName()
- Method in
RenderContext
@return The current action name
getActionName()
- Method in
ServletRenderContext
getArguments()
- Method in
RenderContext
@return 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
@return The current controller name
getControllerName()
- Method in
ServletRenderContext
getControllerNamespace()
- Method in
RenderContext
@return The current controller name
getControllerNamespace()
- Method in
ServletRenderContext
getExcludes()
- Method in
RenderContext
Which properties should be excluded from rendering
getHttpMethod()
- Method in
RenderContext
@return The HTTP method
getHttpMethod()
- Method in
ServletRenderContext
getIncludes()
- Method in
RenderContext
Which properties should be included in rendering
getLinksForObject(def)
- Method in
AbstractLinkingRenderer
getLinkTitle(PersistentEntity, Locale)
- Method in
AbstractLinkingRenderer
getLocale()
- Method in
RenderContext
@return The locale
getLocale()
- Method in
ServletRenderContext
getMimeTypes()
- Method in
DefaultHtmlRenderer
getModelAndView()
- Method in
ServletRenderContext
getObjectId(def)
- Method in
AbstractVndErrorRenderer
getObjectId(PersistentEntity, def)
- Method in
AtomRenderer
getObjectToBind()
- Method in
RestfulController
The object that can be bound to a domain instance.
getResourcePath()
- Method in
RenderContext
@return The path the the resource
getResourcePath()
- Method in
ServletRenderContext
getResourceTitle(String, Locale)
- Method in
AbstractLinkingRenderer
getTargetClassForContainer(Class, Object)
- Method in
DefaultRendererRegistry
getTargetType()
- Method in
AbstractVndErrorRenderer
getTargetType()
- Method in
DefaultHtmlRenderer
getTargetType()
- Method in
Renderer
@return The target type
getTrait()
- Method in
RestResponderTraitInjector
getViewName()
- Method in
RenderContext
@return The view name to use
getViewName()
- Method in
ServletRenderContext
getWriter()
- Method in
RenderContext
@return The writer to render to
getWriter()
- Method in
ServletRenderContext
H
HalJsonCollectionRenderer
- Class in
grails.rest.render.hal
A HAL JSON renderer for a collection of objects
HalJsonCollectionRenderer(Class, 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(Class<T>, MimeType)
- Constructor in
HalJsonRenderer
HalXmlCollectionRenderer
- Class in
grails.rest.render.hal
A HAL XML renderer for a collection of objects
HalXmlCollectionRenderer(Class, 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>, 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
HREFLANG_ATTRIBUTE
- Field in
AbstractLinkingRenderer
I
ID_DATE_FORMAT
- Field in
AtomRenderer
ID_TAG
- Field in
AtomRenderer
includesProperty(Object, String)
- Method in
AbstractIncludeExcludeRenderer
index(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(Class)
- Method in
AbstractLinkingRenderer
J
JsonCollectionRenderer
- Class in
grails.rest.render.json
A JSON renderer for a collection of objects
JsonCollectionRenderer(Class, MimeType)
- Constructor in
JsonCollectionRenderer
JsonRenderer
- Class in
grails.rest.render.json
A JSON renderer that allows including / excluding properties
JsonRenderer(Class<T>, MimeType)
- Constructor in
JsonRenderer
K
L
Link
- Class in
grails.rest
Represents a Link in a RESTful resource.
Link(String, 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
LINKS_ATTRIBUTE
- Field in
HalJsonRenderer
LINKS_ATTRIBUTE
- Field in
VndErrorJsonRenderer
LINKS_METHOD
- Field in
LinkableTransform
listAllResources(Map)
- Method in
RestfulController
List all of resource based on parameters
LOGREF_ATTRIBUTE
- Field in
AbstractVndErrorRenderer
M
MESSAGE_ATTRIBUTE
- Field 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
mimeTypes
- Field in
DefaultHtmlRenderer
N
namespace()
- Method in
Resource
Returns:
The namespace of the resource.
notFound()
- Method in
RestfulController
O
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
PUBLISHED_TAG
- Field in
AtomRenderer
Q
queryForResource(Serializable)
- Method in
RestfulController
Queries for a resource for the given id
R
readOnly()
- Method in
Resource
@default false
Returns:
Whether this is a read-only resource (one that doesn't allow DELETE, POST, PUT or PATCH requests)
REDIRECT_METHOD
- Field in
ResourceTransform
registerCustomConverter()
- Method in
JsonRenderer
registerCustomConverter()
- Method in
XmlRenderer
registerCustomMarshaller(ObjectMarshaller)
- Method in
JsonRenderer
registerCustomMarshaller(ObjectMarshaller)
- Method in
XmlRenderer
registryResourceControllers(GrailsApplication)
- Method in
RestResponderGrailsPlugin
RELATIONSHIP_ALTERNATE
- Field in
AtomRenderer
RELATIONSHIP_ATTRIBUTE
- Field in
HalXmlRenderer
RELATIONSHIP_SELF
- Field in
AbstractLinkingRenderer
render(T, RenderContext)
- Method in
AbstractLinkingRenderer
render(T, RenderContext)
- Method in
DefaultHtmlRenderer
render(T, RenderContext)
- Method in
DefaultJsonRenderer
render(T, RenderContext)
- Method in
DefaultXmlRenderer
RENDER_METHOD
- Field in
ResourceTransform
render(T, RenderContext)
- Method in
Renderer
Renders the object
render(Errors, RenderContext)
- Method in
VndErrorJsonRenderer
render(Errors, RenderContext)
- Method in
VndErrorXmlRenderer
RenderContext
- Interface in
grails.rest.render
Passed to a renderer to provide context information
renderEmbeddedAttributes(StreamingJsonDelegate, def, RenderContext, 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
@author Graeme Rocher
renderInternal(T, RenderContext)
- Method in
AbstractLinkingRenderer
renderInternal(T, RenderContext)
- Method in
AtomRenderer
renderInternal(T, RenderContext)
- Method in
HalJsonRenderer
renderInternal(T, RenderContext)
- Method in
HalXmlRenderer
renderJson(JSON, RenderContext)
- Method in
DefaultJsonRenderer
renderJson(JSON, RenderContext)
- Method in
JsonCollectionRenderer
renderJson(JSON, RenderContext)
- Method in
JsonRenderer
renderXml(XML, RenderContext)
- Method in
DefaultXmlRenderer
Subclasses should override to customize XML response rendering
renderXml(XML, RenderContext)
- Method in
XmlCollectionRenderer
renderXml(XML, RenderContext)
- Method in
XmlRenderer
resolveLogRef(def, ObjectError)
- Method in
AbstractVndErrorRenderer
Resolve the 'logref' attribute for the error
resolveModelVariableName(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_TAG
- Field in
HalXmlRenderer
ResourceTransform
- Class in
org.grails.plugins.web.rest.transform
The Resource transform automatically exposes a domain class as a RESTful resource.
RESPOND_METHOD
- Field in
ResourceTransform
respond(def, 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
@author Jeff Brown
RestResponderGrailsPlugin
- Class in
org.grails.plugins.web.rest.plugin
@since 2.3
RestResponderTraitInjector
- Class in
grails.compiler.traits
@author Jeff Brown
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(GrailsWebRequest, Map<String, Object>)
- Constructor in
ServletRenderContext
setCompilationUnit(CompilationUnit)
- Method in
ResourceTransform
setContentType(String)
- Method in
RenderContext
Sets the content type of the rendered response
setContentType(String)
- Method in
ServletRenderContext
setDateToStringConverter(Converter<Date, String>)
- Method in
HalJsonRenderer
setModel(Map)
- Method in
RenderContext
The model to use for the response
setModel(Map)
- Method in
ServletRenderContext
setRenderers(Renderer)
- Method in
DefaultRendererRegistry
setResourcePath(String)
- Method in
ServletRenderContext
setStatus(HttpStatus)
- Method in
RenderContext
@param status The status to set
setStatus(HttpStatus)
- Method in
ServletRenderContext
setViewName(String)
- Method in
RenderContext
The view to use for the response
setViewName(String)
- Method in
ServletRenderContext
shouldIncludeProperty(RenderContext, Object, String)
- Method in
AbstractIncludeExcludeRenderer
show()
- Method in
RestfulController
Shows a single resource
startResourceTag(XMLStreamWriter, String, Locale, String)
- Method in
HalXmlRenderer
startResourceTagForCurrentPath(RenderContext, XMLStreamWriter)
- Method in
HalXmlRenderer
superClass()
- Method in
Resource
@default RestfulController
Returns:
The super class to use for the generated controller class
T
targetType
- Field in
DefaultHtmlRenderer
TEMPLATED_ATTRIBUTE
- Field in
AbstractLinkingRenderer
TITLE_ATTRIBUTE
- Field in
AbstractLinkingRenderer
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
visit(ASTNode, SourceUnit)
- Method in
LinkableTransform
visit(ASTNode, 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)
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)
W
wasWrittenTo()
- Method in
RenderContext
Returns true if the getWriter() method was called
wasWrittenTo()
- Method in
ServletRenderContext
writeAssociationLinks(RenderContext, def, Locale, def, PersistentEntity, MetaClass)
- Method in
AbstractLinkingRenderer
writeDomain(RenderContext, MetaClass, PersistentEntity, Object, def)
- Method in
AbstractLinkingRenderer
Writes a domain instance
writeDomainProperty(def, String, def)
- Method in
AbstractLinkingRenderer
writeDomainProperty(def, String, def)
- Method in
HalJsonRenderer
writeDomainProperty(def, String, def)
- Method in
HalXmlRenderer
writeDomainWithEmbeddedAndLinks(PersistentEntity, Object, RenderContext, XML, Set, boolean)
- Method in
AtomRenderer
writeDomainWithEmbeddedAndLinks(RenderContext, Class, Object, StreamingJsonDelegate, Locale, MimeType, Set, Stack)
- Method in
HalJsonRenderer
writeDomainWithEmbeddedAndLinks(PersistentEntity, def, RenderContext, XML, Set)
- Method in
HalXmlRenderer
writeExtraLinks(def, Locale, def)
- Method in
AbstractLinkingRenderer
writeLink(Link, Locale, def)
- Method in
AbstractLinkingRenderer
writeLink(Link, Locale, def)
- Method in
HalJsonRenderer
writeLink(Link, Locale, def)
- Method in
HalXmlRenderer
writeLinkForCurrentPath(RenderContext, MimeType, StreamingJsonDelegate)
- Method in
HalJsonRenderer
writeLinks(RenderContext, MetaClass, def, PersistentEntity, Locale, MimeType, StreamingJsonDelegate, boolean)
- Method in
HalJsonRenderer
writeSimpleObject(Object, RenderContext, StreamingJsonDelegate)
- Method in
HalJsonRenderer
writeSimpleObjectAndLink(Object, RenderContext, StreamingJsonDelegate, MimeType)
- Method in
HalJsonRenderer
X
XmlCollectionRenderer
- Class in
grails.rest.render.xml
A XML renderer for a collection of objects
XmlCollectionRenderer(Class, 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(Class<T>, 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