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

Class JsonDocumentWriter

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonESDocumentWriter

@Provider
public class JsonDocumentWriter
extends Object
implements javax.ws.rs.ext.MessageBodyWriter<DocumentModel>

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_PROPERTIES_HEADER

Constructor Summary

Constructors

Constructor and Description
JsonDocumentWriter()

Method Summary

Methods

Modifier and Type	Method and Description
long	getSize(DocumentModel arg0, Class<?> arg1, Type arg2, Annotation[] arg3, javax.ws.rs.core.MediaType arg4)
boolean	isWriteable(Class<?> arg0, Type arg1, Annotation[] arg2, javax.ws.rs.core.MediaType arg3)
static void	writeDocument(org.codehaus.jackson.JsonGenerator jg, DocumentModel doc, String[] schemas, Map<String,String> contextParameters, javax.ws.rs.core.HttpHeaders headers, javax.servlet.ServletRequest request)
static void	writeDocument(org.codehaus.jackson.JsonGenerator jg, DocumentModel doc, String[] schemas, Map<String,String> contextParameters, javax.servlet.ServletRequest request)
static void	writeDocument(org.codehaus.jackson.JsonGenerator jg, DocumentModel doc, String[] schemas, javax.servlet.ServletRequest request)
void	writeDocument(OutputStream out, DocumentModel doc, String[] schemas)
void	writeDocument(OutputStream out, DocumentModel doc, String[] schemas, Map<String,String> contextParameters)
static void	writePropertyValue(org.codehaus.jackson.JsonGenerator jg, Property prop, String filesBaseUrl) Converts the value of the given core property to JSON format.
void	writeTo(DocumentModel doc, Class<?> arg1, Type arg2, Annotation[] arg3, javax.ws.rs.core.MediaType arg4, javax.ws.rs.core.MultivaluedMap<String,Object> arg5, OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_PROPERTIES_HEADER

public static final String DOCUMENT_PROPERTIES_HEADER

See Also:

Constant Field Values

Constructor Detail

JsonDocumentWriter

public JsonDocumentWriter()

Method Detail

getSize

public long getSize(DocumentModel arg0,
           Class<?> arg1,
           Type arg2,
           Annotation[] arg3,
           javax.ws.rs.core.MediaType arg4)

Specified by:

getSize in interface javax.ws.rs.ext.MessageBodyWriter<DocumentModel>

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<DocumentModel>

writeTo

public void writeTo(DocumentModel doc,
           Class<?> arg1,
           Type arg2,
           Annotation[] arg3,
           javax.ws.rs.core.MediaType arg4,
           javax.ws.rs.core.MultivaluedMap<String,Object> arg5,
           OutputStream out)
             throws IOException,
                    javax.ws.rs.WebApplicationException

Specified by:

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

Throws:

IOException

javax.ws.rs.WebApplicationException

writeDocument

public void writeDocument(OutputStream out,
                 DocumentModel doc,
                 String[] schemas)
                   throws Exception

Throws:

Exception

writeDocument

public void writeDocument(OutputStream out,
                 DocumentModel doc,
                 String[] schemas,
                 Map<String,String> contextParameters)
                   throws Exception

Throws:

Exception

Since:

5.6

writeDocument

public static void writeDocument(org.codehaus.jackson.JsonGenerator jg,
                 DocumentModel doc,
                 String[] schemas,
                 javax.servlet.ServletRequest request)
                          throws Exception

Throws:

Exception

writeDocument

public static void writeDocument(org.codehaus.jackson.JsonGenerator jg,
                 DocumentModel doc,
                 String[] schemas,
                 Map<String,String> contextParameters,
                 javax.servlet.ServletRequest request)
                          throws Exception

Throws:

Exception

Since:

5.6

writeDocument

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

Parameters:

jg - a ready to user JSON generator

doc - the document to serialize

schemas - an array of schemas that must be serialized in the properties map

contextParameters -

headers -

request - the ServletRequest. If null blob URLs won't be generated.

Throws:

Exception

Since:

5.7.3

writePropertyValue

public static void writePropertyValue(org.codehaus.jackson.JsonGenerator jg,
                      Property prop,
                      String filesBaseUrl)
                               throws PropertyException,
                                      org.codehaus.jackson.JsonGenerationException,
                                      IOException

Converts the value of the given core property to JSON format. The given filesBaseUrl is the baseUrl that can be used to locate blob content and is useful to generate blob urls.

Throws:

PropertyException

org.codehaus.jackson.JsonGenerationException

IOException