Package org.nuxeo.ecm.restapi.server.comment

Class AnnotationAdapter

java.lang.Object

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

org.nuxeo.ecm.webengine.model.impl.DefaultAdapter

org.nuxeo.ecm.restapi.server.comment.AnnotationAdapter

All Implemented Interfaces:

AdapterResource, Resource, Adaptable

@Produces("application/json")
public class AnnotationAdapter
extends DefaultAdapter

Since:

10.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
AnnotationAdapter()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createAnnotation(Annotation annotation)
jakarta.ws.rs.core.Response	deleteAnnotation(String annotationId)
jakarta.ws.rs.core.Response	deleteExternalAnnotation(String entityId)
Annotation	getAnnotation(String annotationId)
List<Annotation>	getAnnotations(String xpath)
List<Comment>	getComments(List<String> annotationIds)	Deprecated. since 11.3, use getCommentsFromBody(String) instead
List<Comment>	getCommentsFromBody(String payload)
Annotation	getExternalAnnotation(String entityId)
Annotation	updateAnnotation(String annotationId, Annotation annotation)
Annotation	updateExternalAnnotation(String entityId, Annotation annotation)

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

disptachAdapter, getTarget, isAdapter

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Adaptable

getAdapter

Methods inherited from interface org.nuxeo.ecm.webengine.model.Resource

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

AnnotationAdapter

public AnnotationAdapter()

Method Details

createAnnotation

@POST
public jakarta.ws.rs.core.Response createAnnotation(Annotation annotation)

getAnnotations

@GET
public List<Annotation> getAnnotations(@QueryParam("xpath")
 String xpath)

getComments

@GET
@Path("comments")
@Deprecated(since="11.3")
public List<Comment> getComments(@QueryParam("annotationIds")
 List<String> annotationIds)

Deprecated.

since 11.3, use getCommentsFromBody(String) instead

getCommentsFromBody

@POST
@Path("comments")
public List<Comment> getCommentsFromBody(String payload)

getAnnotation

@GET
@Path("{annotationId}")
public Annotation getAnnotation(@PathParam("annotationId")
 String annotationId)

getExternalAnnotation

@GET
@Path("external/{entityId}")
public Annotation getExternalAnnotation(@PathParam("entityId")
 String entityId)

updateAnnotation

@PUT
@Path("{annotationId}")
public Annotation updateAnnotation(@PathParam("annotationId")
 String annotationId,
 Annotation annotation)

updateExternalAnnotation

@PUT
@Path("external/{entityId}")
public Annotation updateExternalAnnotation(@PathParam("entityId")
 String entityId,
 Annotation annotation)

deleteAnnotation

@DELETE
@Path("{annotationId}")
public jakarta.ws.rs.core.Response deleteAnnotation(@PathParam("annotationId")
 String annotationId)

deleteExternalAnnotation

@DELETE
@Path("external/{entityId}")
public jakarta.ws.rs.core.Response deleteExternalAnnotation(@PathParam("entityId")
 String entityId)