org.nuxeo.ecm.automation.jaxrs.io.documents

Class JsonDocumentListWriter

java.lang.Object

org.nuxeo.ecm.automation.jaxrs.io.EntityWriter<List<T>>

org.nuxeo.ecm.automation.jaxrs.io.EntityListWriter<DocumentModel>

org.nuxeo.ecm.automation.jaxrs.io.documents.JsonDocumentListWriter

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyWriter<List<DocumentModel>>

Direct Known Subclasses:

JsonESDocumentListWriter

@Provider
public class JsonDocumentListWriter
extends EntityListWriter<DocumentModel>

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.ws.rs.core.HttpHeaders	headers
protected javax.servlet.http.HttpServletRequest	request

Constructor Summary

Constructors

Constructor and Description
JsonDocumentListWriter()

Method Summary

Modifier and Type	Method and Description
protected String	getEntityType() Returns the entity-type value of the list (ie: users, groups....)
boolean	isWriteable(Class<?> arg0, Type arg1, Annotation[] arg2, javax.ws.rs.core.MediaType arg3)
static void	writeDocuments(org.codehaus.jackson.JsonGenerator jg, List<DocumentModel> docs, String[] schemas, javax.ws.rs.core.HttpHeaders headers, javax.servlet.ServletRequest request)
static void	writeDocuments(org.codehaus.jackson.JsonGenerator jg, List<DocumentModel> docs, String[] schemas, javax.servlet.ServletRequest request)
void	writeDocuments(OutputStream out, List<DocumentModel> docs, String[] schemas)
void	writeDocuments(OutputStream out, List<DocumentModel> docs, String[] schemas, javax.ws.rs.core.HttpHeaders headers)
protected void	writeItem(org.codehaus.jackson.JsonGenerator jg, DocumentModel item) Writes the item in a JsonGenerator.
void	writeTo(List<DocumentModel> docs, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream)

Methods inherited from class org.nuxeo.ecm.automation.jaxrs.io.EntityListWriter

writeEntityBody, writeHeader, writePaginableHeader

Methods inherited from class org.nuxeo.ecm.automation.jaxrs.io.EntityWriter

getSize, writeEntity

Methods inherited from class java.lang.Object

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

Field Detail

headers

@Context
protected javax.ws.rs.core.HttpHeaders headers

request

@Context
protected javax.servlet.http.HttpServletRequest request

Constructor Detail

JsonDocumentListWriter

public JsonDocumentListWriter()

Method Detail

getEntityType

protected String getEntityType()

Description copied from class: EntityListWriter

Returns the entity-type value of the list (ie: users, groups....)

Specified by:

getEntityType in class EntityListWriter<DocumentModel>

Returns:

the string representing the entity-type.

writeItem

protected void writeItem(org.codehaus.jackson.JsonGenerator jg,
                         DocumentModel item)
                  throws ClientException,
                         IOException

Description copied from class: EntityListWriter

Writes the item in a JsonGenerator.

Specified by:

writeItem in class EntityListWriter<DocumentModel>

Throws:

ClientException

IOException

isWriteable

public boolean isWriteable(Class<?> arg0,
                           Type arg1,
                           Annotation[] arg2,
                           javax.ws.rs.core.MediaType arg3)

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<List<DocumentModel>>

Overrides:

isWriteable in class EntityListWriter<DocumentModel>

writeTo

public void writeTo(List<DocumentModel> docs,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    javax.ws.rs.core.MediaType mediaType,
                    javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
                    OutputStream entityStream)
             throws IOException,
                    javax.ws.rs.WebApplicationException

Specified by:

writeTo in interface javax.ws.rs.ext.MessageBodyWriter<List<DocumentModel>>

Overrides:

writeTo in class EntityWriter<List<DocumentModel>>

Throws:

IOException

javax.ws.rs.WebApplicationException

writeDocuments

public void writeDocuments(OutputStream out,
                           List<DocumentModel> docs,
                           String[] schemas)
                    throws Exception

Throws:

Exception

writeDocuments

public void writeDocuments(OutputStream out,
                           List<DocumentModel> docs,
                           String[] schemas,
                           javax.ws.rs.core.HttpHeaders headers)
                    throws Exception

Throws:

Exception

Since:

5.9.5

writeDocuments

public static void writeDocuments(org.codehaus.jackson.JsonGenerator jg,
                                  List<DocumentModel> docs,
                                  String[] schemas,
                                  javax.servlet.ServletRequest request)
                           throws Exception

Throws:

Exception

writeDocuments

public static void writeDocuments(org.codehaus.jackson.JsonGenerator jg,
                                  List<DocumentModel> docs,
                                  String[] schemas,
                                  javax.ws.rs.core.HttpHeaders headers,
                                  javax.servlet.ServletRequest request)
                           throws Exception

Throws:

Exception

Since:

5.9.5