Package com.logicaldoc.conversion.webservice.rest.endpoint

Class RestConversionService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.conversion.webservice.soap.endpoint.SoapConversionService

com.logicaldoc.conversion.webservice.rest.endpoint.RestConversionService

All Implemented Interfaces:

ConversionService, ConversionService

@Path("/")
@Consumes({"application/xml","application/json"})
@Produces("application/json")
public class RestConversionService
extends SoapConversionService
implements ConversionService

Constructor Summary

Constructors

Constructor	Description
RestConversionService()

Method Summary

Modifier and Type	Method	Description
javax.activation.DataHandler	convertDocument(long docId, String fileVersion, String format)	Converts an existing document and saves the generated conversion in LogicalDOC.
long	convertDocumentAndSave(long docId, String fileVersion, String format)	Converts an existing document and saves the generated conversion in LogicalDOC.
void	convertDocumentToPdf(long docId, String fileVersion)	Creates the PDF conversion of the given document.
javax.activation.DataHandler	convertFile(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)	Converts a given file and returns the conversion.

Methods inherited from class com.logicaldoc.conversion.webservice.soap.endpoint.SoapConversionService

convertDocument, convertDocumentAndSave, convertDocumentToPdf, convertFile

Methods inherited from class com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession

Methods inherited from class java.lang.Object

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

Constructor Detail

RestConversionService

public RestConversionService()

Method Detail

convertDocument

@GET
@Path("/convertDocument")
@Produces("application/octet-stream")
public javax.activation.DataHandler convertDocument(@QueryParam("docId")
                                                    long docId,
                                                    @QueryParam("fileVersion")
                                                    String fileVersion,
                                                    @QueryParam("format")
                                                    String format)
                                             throws Exception

Description copied from interface: ConversionService

Converts an existing document and saves the generated conversion in LogicalDOC.

Specified by:

convertDocument in interface ConversionService

Parameters:

docId - The document id

fileVersion - The file version

format - The output conversion format

Returns:

The conversion's binary

Throws:

Exception - error in the service

convertDocumentAndSave

@GET
@Path("/convertDocumentAndSave")
@Produces("text/plain")
public long convertDocumentAndSave(@QueryParam("docId")
                                   long docId,
                                   @QueryParam("fileVersion")
                                   String fileVersion,
                                   @QueryParam("format")
                                   String format)
                            throws Exception

Description copied from interface: ConversionService

Converts an existing document and saves the generated conversion in LogicalDOC.

Specified by:

convertDocumentAndSave in interface ConversionService

Parameters:

docId - The document id

fileVersion - The file version

format - The output conversion format

Returns:

the ID of the generated conversion file

Throws:

Exception - error in the service

convertDocumentToPdf

@GET
@Path("/convertDocumentToPdf")
public void convertDocumentToPdf(@QueryParam("docId")
                                 long docId,
                                 @QueryParam("fileVersion")
                                 String fileVersion)
                          throws Exception

Description copied from interface: ConversionService

Creates the PDF conversion of the given document. If the conversion was already created, nothing will happen.

Specified by:

convertDocumentToPdf in interface ConversionService

Parameters:

docId - The document id

fileVersion - The specific file version(it can be empty)

Throws:

Exception - error in the service

convertFile

@POST
@Path("/convertFile")
@Consumes("multipart/form-data")
@Produces("application/octet-stream")
public javax.activation.DataHandler convertFile(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)
                                         throws Exception

Description copied from interface: ConversionService

Converts a given file and returns the conversion. Expected attachments are:

1. fileName - name of the original file
2. format - The output format (ag: pdf, ods, doc)
3. fileContent - The content of the original file

Specified by:

convertFile in interface ConversionService

Parameters:

attachments - list of attachments

Returns:

the raw content of the converted file

Throws:

Exception - error in the service