A C D E F G I M N O R S T U V W

A

AbstractAnnotationRESTResource - Class in org.xwiki.annotation.rest.internal

Base class for the annotation REST services, to implement common functionality to all annotation REST services.

AbstractAnnotationRESTResource() - Constructor for class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

AbstractFormUrlEncodedAnnotationRequestReader<T extends AnnotationRequest> - Class in org.xwiki.annotation.rest.internal.representations

Partial implementation of a reader from form submits requests for annotation related types, to handle generic request reader code.

AbstractFormUrlEncodedAnnotationRequestReader() - Constructor for class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

AbstractFormUrlEncodedAnnotationUpdateRequestReader<T extends AnnotationUpdateRequest> - Class in org.xwiki.annotation.rest.internal.representations

Partial implementation of a reader that reads an annotation update request, extending the request reader with the read of the annotation fields.

AbstractFormUrlEncodedAnnotationUpdateRequestReader() - Constructor for class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationUpdateRequestReader

Adapter1 - Class in org.xwiki.annotation.rest.model.jaxb

Adapter1() - Constructor for class org.xwiki.annotation.rest.model.jaxb.Adapter1

AnnotatedContent - Class in org.xwiki.annotation.rest.model.jaxb

Stores the rendered annotated content along with a list of annotation stubs allowing to display an annotated document and the annotation markers on it.

AnnotatedContent() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

annotatedContent - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

annotation - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

AnnotationAddRequest - Class in org.xwiki.annotation.rest.model.jaxb

Extends the annotation update request by adding the set of 'special' fields for annotation selection.

AnnotationAddRequest() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

AnnotationField - Class in org.xwiki.annotation.rest.model.jaxb

Stores an extra field (any field besides the required ones) for an annotation, as a simple string element, with the name of the extra field in an attribute.

AnnotationField() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationField

AnnotationFieldCollection - Class in org.xwiki.annotation.rest.model.jaxb

Stores the information about a request for an annotation to be updated, which is basically any collection of fields.

AnnotationFieldCollection() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationFieldCollection

annotationId - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

AnnotationRequest - Class in org.xwiki.annotation.rest.model.jaxb

Stores the information about an annotations request: what annotations should be returned with the annotated content and the annotations stubs.

AnnotationRequest() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

AnnotationRequest.Request - Class in org.xwiki.annotation.rest.model.jaxb

Java class for anonymous complex type.

AnnotationRequest.Request() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest.Request

AnnotationResponse - Class in org.xwiki.annotation.rest.model.jaxb

Stores the server response for an annotation request, containing the annotated content requested, a response code and a response message.

AnnotationResponse() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

annotationRightService - Variable in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

The annotations rights checking service, to check user rights to perform annotations actions.

annotations - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

annotationService - Variable in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

The annotations service to be used by this REST interface.

AnnotationsRESTResource - Class in org.xwiki.annotation.rest.internal

AnnotationsRESTResource() - Constructor for class org.xwiki.annotation.rest.internal.AnnotationsRESTResource

AnnotationStub - Class in org.xwiki.annotation.rest.model.jaxb

Stores stub information about an annotation, such as the id, its target and its state, allowing it to be further requested from the annotation service for the extra details.

AnnotationStub() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

AnnotationUpdateRequest - Class in org.xwiki.annotation.rest.model.jaxb

Stores a request for an annotation to be updated: besides the annotation request components, a collection of fields for the annotation.

AnnotationUpdateRequest() - Constructor for class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

C

content - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

createAnnotatedContent() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotatedContent

createAnnotationAddRequest() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationAddRequest

createAnnotationDeleteRequest(AnnotationRequest) - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of JAXBElement<AnnotationRequest>}

createAnnotationField() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationField

createAnnotationFieldCollection() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationFieldCollection

createAnnotationRequest() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationRequest

createAnnotationRequestRequest() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationRequest.Request

createAnnotationResponse() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationResponse

createAnnotationStub() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationStub

createAnnotationUpdateRequest() - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of AnnotationUpdateRequest

createAnnotationUpdateRequest(AnnotationUpdateRequest) - Method in class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create an instance of JAXBElement<AnnotationUpdateRequest>}

D

DEFAULT_ACTION - Static variable in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

The default action to render the document for.

doDelete(String, String, String, String, AnnotationRequest) - Method in class org.xwiki.annotation.rest.internal.SingleAnnotationRESTResource

Deletes the specified annotation.

doGetAnnotatedContent(String, String, String, AnnotationRequest) - Method in class org.xwiki.annotation.rest.internal.AnnotationsRESTResource

doPostAnnotation(String, String, String, AnnotationAddRequest) - Method in class org.xwiki.annotation.rest.internal.AnnotationsRESTResource

Add annotation to a given page.

doUpdate(String, String, String, String, AnnotationUpdateRequest) - Method in class org.xwiki.annotation.rest.internal.SingleAnnotationRESTResource

Updates the specified annotation with the values of the fields in received collection.

E

execution - Variable in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

The execution needed to get the annotation author from the context user.

F

fields - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationFieldCollection

fields - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest.Request

fields - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

filter - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

FILTER_FIELD_PREFIX - Static variable in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

The prefix of the parameters of the annotations filters.

filterAnnotations(Collection<Annotation>, AnnotationRequest) - Method in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

Helper method to filter a set of annotations according to the criteria in the passed annotation request.

FormUrlEncodedAnnotationAddRequestReader - Class in org.xwiki.annotation.rest.internal.representations

Implementation of the form url encoded reader for the annotation creation requests.

FormUrlEncodedAnnotationAddRequestReader() - Constructor for class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationAddRequestReader

FormUrlEncodedAnnotationRequestReader - Class in org.xwiki.annotation.rest.internal.representations

FormUrlEncodedAnnotationRequestReader() - Constructor for class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationRequestReader

FormUrlEncodedAnnotationUpdateRequestReader - Class in org.xwiki.annotation.rest.internal.representations

Implementation of the form url encoded reader for the annotation update requests.

FormUrlEncodedAnnotationUpdateRequestReader() - Constructor for class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationUpdateRequestReader

G

getAnnotatedContent() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Gets the value of the annotatedContent property.

getAnnotation() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

Gets the value of the annotation property.

getAnnotationId() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Gets the value of the annotationId property.

getAnnotations() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

Gets the value of the annotations property.

getContent() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

Gets the value of the content property.

getErrorResponse(Throwable) - Method in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

Helper function to create an error response from a passed exception.

getFields() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationFieldCollection

Gets the value of the fields property.

getFields() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest.Request

Gets the value of the fields property.

getFields() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Gets the value of the fields property.

getFilter() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

Gets the value of the filter property.

getMap(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.internal.AnnotationsRESTResource

Builds a simple map from a field collection.

getName() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

Gets the value of the name property.

getReadObjectInstance(ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

Helper function to provide an instance of the read object from the object factory.

getReadObjectInstance(ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationAddRequestReader

Helper function to provide an instance of the read object from the object factory.

getReadObjectInstance(ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationRequestReader

Helper function to provide an instance of the read object from the object factory.

getReadObjectInstance(ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationUpdateRequestReader

Helper function to provide an instance of the read object from the object factory.

getRequest() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

Gets the value of the request property.

getResponseCode() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Gets the value of the responseCode property.

getResponseMessage() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Gets the value of the responseMessage property.

getSelection() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Gets the value of the selection property.

getSelectionContext() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Gets the value of the selectionContext property.

getSelectionOffset() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Gets the value of the selectionOffset property.

getState() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Gets the value of the state property.

getSuccessResponseWithAnnotatedContent(String, AnnotationRequest) - Method in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

Builds an annotation response containing the annotated content along with the annotation stubs, according to the requirements in the passed annotations request.

getTarget() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Gets the value of the target property.

getValue() - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

Gets the value of the value property.

getXWikiUser() - Method in class org.xwiki.annotation.rest.internal.AbstractAnnotationRESTResource

I

isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationAddRequestReader

isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationRequestReader

isReadable(Class<?>, Type, Annotation[], MediaType) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationUpdateRequestReader

M

marshal(Calendar) - Method in class org.xwiki.annotation.rest.model.jaxb.Adapter1

N

name - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

O

ObjectFactory - Class in org.xwiki.annotation.rest.model.jaxb

This object contains factory methods for each Java content interface and Java element interface generated in the org.xwiki.annotation.rest.model.jaxb package.

ObjectFactory() - Constructor for class org.xwiki.annotation.rest.model.jaxb.ObjectFactory

Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: org.xwiki.annotation.rest.model.jaxb

org.xwiki.annotation.rest.internal - package org.xwiki.annotation.rest.internal

org.xwiki.annotation.rest.internal.representations - package org.xwiki.annotation.rest.internal.representations

org.xwiki.annotation.rest.model.jaxb - package org.xwiki.annotation.rest.model.jaxb

R

readFrom(Class<T>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

request - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

REQUESTED_FIELD - Static variable in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

The parameter name for a field requested to appear in the annotations stub.

responseCode - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

responseMessage - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

S

saveField(T, String, String, ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationRequestReader

Helper function to save a parameter in the read object.

saveField(T, String, String, ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.AbstractFormUrlEncodedAnnotationUpdateRequestReader

Helper function to save a parameter in the read object.

saveField(AnnotationAddRequest, String, String, ObjectFactory) - Method in class org.xwiki.annotation.rest.internal.representations.FormUrlEncodedAnnotationAddRequestReader

Helper function to save a parameter in the read object.

selection - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

selectionContext - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

selectionOffset - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

setAnnotatedContent(AnnotatedContent) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Sets the value of the annotatedContent property.

setAnnotation(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

Sets the value of the annotation property.

setAnnotationId(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Sets the value of the annotationId property.

setContent(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

Sets the value of the content property.

setFilter(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

Sets the value of the filter property.

setName(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

Sets the value of the name property.

setRequest(AnnotationRequest.Request) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

Sets the value of the request property.

setResponseCode(int) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Sets the value of the responseCode property.

setResponseMessage(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

Sets the value of the responseMessage property.

setSelection(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Sets the value of the selection property.

setSelectionContext(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Sets the value of the selectionContext property.

setSelectionOffset(int) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

Sets the value of the selectionOffset property.

setState(Object) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Sets the value of the state property.

setTarget(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

Sets the value of the target property.

setValue(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

Sets the value of the value property.

SingleAnnotationRESTResource - Class in org.xwiki.annotation.rest.internal

This class allow to do delete a single annotation.

SingleAnnotationRESTResource() - Constructor for class org.xwiki.annotation.rest.internal.SingleAnnotationRESTResource

state - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

T

target - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

U

unmarshal(String) - Method in class org.xwiki.annotation.rest.model.jaxb.Adapter1

V

value - Variable in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

W

withAnnotatedContent(AnnotatedContent) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

withAnnotation(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withAnnotation(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

withAnnotationId(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

withAnnotations(AnnotationStub...) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

withAnnotations(Collection<AnnotationStub>) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

withContent(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotatedContent

withFields(AnnotationField...) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationFieldCollection

withFields(Collection<AnnotationField>) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationFieldCollection

withFields(String...) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest.Request

withFields(Collection<String>) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest.Request

withFields(AnnotationField...) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

withFields(Collection<AnnotationField>) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

withFilter(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withFilter(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

withFilter(AnnotationFieldCollection) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

withName(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

withRequest(AnnotationRequest.Request) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withRequest(AnnotationRequest.Request) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

withRequest(AnnotationRequest.Request) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationUpdateRequest

withResponseCode(int) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

withResponseMessage(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationResponse

withSelection(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withSelectionContext(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withSelectionOffset(int) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationAddRequest

withState(Object) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

withTarget(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationStub

withValue(String) - Method in class org.xwiki.annotation.rest.model.jaxb.AnnotationField

A C D E F G I M N O R S T U V W