Package org.nuxeo.ecm.restapi.server

Class JSONDocumentObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.core.rest.DocumentObject

org.nuxeo.ecm.restapi.server.JSONDocumentObject

All Implemented Interfaces:

Resource, Adaptable

@Produces("application/json")
public class JSONDocumentObject
extends DocumentObject

This object basically overrides the default DocumentObject that doesn't know how to produce/consume JSON

Since:

5.7.2

Field Summary

Fields inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doc

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
JSONDocumentObject()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	doDelete()
jakarta.ws.rs.core.Response	doGet()
jakarta.ws.rs.core.Response	doPost(DocumentModel inputDoc, jakarta.ws.rs.core.HttpHeaders headers)
DocumentModel	doPut(DocumentModel inputDoc, jakarta.ws.rs.core.HttpHeaders headers)
DocumentObject	newDocument(String path)
DocumentObject	newDocument(DocumentModel doc)
DocumentObject	newDocument(DocumentRef ref)
Object	search()
protected void	updateCommentFromHeader(jakarta.ws.rs.core.HttpHeaders headers)	Fills the doc context data with a comment from the Update-Comment header if present.

Methods inherited from class org.nuxeo.ecm.core.rest.DocumentObject

doPost, doPut, getAdapter, getCoreSession, getDelete, getDocument, getPut, getTitle, initialize, traverse

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, retrieveWebObjectType, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JSONDocumentObject

public JSONDocumentObject()

Method Details

doGet

@GET
public jakarta.ws.rs.core.Response doGet()

Overrides:

doGet in class DocumentObject

doPut

@PUT
@Consumes("application/json")
public DocumentModel doPut(DocumentModel inputDoc,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers)

Returns:

the document or the last version document in case of versioning handled

doPost

@POST
@Consumes("application/json")
public jakarta.ws.rs.core.Response doPost(DocumentModel inputDoc,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers)

doDelete

@DELETE
public jakarta.ws.rs.core.Response doDelete()

Overrides:

doDelete in class DocumentObject

search

@Path("@search")
public Object search()

Overrides:

search in class DocumentObject

newDocument

public DocumentObject newDocument(String path)

Overrides:

newDocument in class DocumentObject

newDocument

public DocumentObject newDocument(DocumentRef ref)

Overrides:

newDocument in class DocumentObject

newDocument

public DocumentObject newDocument(DocumentModel doc)

Overrides:

newDocument in class DocumentObject

updateCommentFromHeader

protected void updateCommentFromHeader(jakarta.ws.rs.core.HttpHeaders headers)

Fills the doc context data with a comment from the Update-Comment header if present.

Since:

9.3