Package com.logicaldoc.enterprise.webservice.rest.endpoint

Class RestEnterpriseDocumentService

java.lang.Object

com.logicaldoc.webservice.AbstractService

com.logicaldoc.enterprise.webservice.soap.endpoint.SoapEnterpriseDocumentService

com.logicaldoc.enterprise.webservice.rest.endpoint.RestEnterpriseDocumentService

All Implemented Interfaces:

EnterpriseDocumentService, EnterpriseDocumentService

@Path("/")
@Consumes("application/json")
@Produces("application/json")
public class RestEnterpriseDocumentService
extends SoapEnterpriseDocumentService
implements EnterpriseDocumentService

Field Summary

Fields inherited from class com.logicaldoc.enterprise.webservice.soap.endpoint.SoapEnterpriseDocumentService

CHUNK_NUMBER_FORMAT

Constructor Summary

Constructors

Constructor	Description
RestEnterpriseDocumentService()

Method Summary

Modifier and Type	Method	Description
void	checkin(Long docId, String comment, String filename, String releaseStr, com.logicaldoc.webservice.model.WSDocument docVO)	Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks
com.logicaldoc.webservice.model.WSDocument	create(com.logicaldoc.webservice.model.WSDocument document)	Creates a new document using the uploaded chunks.
void	deleteChunks()	Deletes all the chunks in the current upload session
javax.activation.DataHandler	downloadChunk(long docId, String version, long start, long length)
void	uploadChunk(byte[] messageBody)
void	uploadChunkSB(InputStream is)

Methods inherited from class com.logicaldoc.enterprise.webservice.soap.endpoint.SoapEnterpriseDocumentService

checkin, create, deleteChunks, downloadChunk, uploadChunk

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

RestEnterpriseDocumentService

public RestEnterpriseDocumentService()

Method Detail

uploadChunk

@POST
@Path("/uploadChunk")
@Consumes("application/octet-stream")
public void uploadChunk(byte[] messageBody)
                 throws Exception

Specified by:

uploadChunk in interface EnterpriseDocumentService

Throws:

Exception

uploadChunkSB

@POST
@Path("/uploadChunkSB")
@Consumes("application/octet-stream")
public void uploadChunkSB(InputStream is)
                   throws Exception

Specified by:

uploadChunkSB in interface EnterpriseDocumentService

Throws:

Exception

deleteChunks

@DELETE
@Path("/deleteChunks")
public void deleteChunks()
                  throws Exception

Description copied from interface: EnterpriseDocumentService

Deletes all the chunks in the current upload session

Specified by:

deleteChunks in interface EnterpriseDocumentService

Throws:

Exception - a generic error

create

@POST
@Path("/create")
public com.logicaldoc.webservice.model.WSDocument create(com.logicaldoc.webservice.model.WSDocument document)
                                                  throws Exception

Description copied from interface: EnterpriseDocumentService

Creates a new document using the uploaded chunks. The user can completely customize the document through a value object containing the document's metadata

Specified by:

create in interface EnterpriseDocumentService

Parameters:

document - Web service value object containing the document's metadata

Returns:

The value object containing the document's metadata

Throws:

Exception - error in the server or in the database

downloadChunk

@GET
@Path("/downloadChunk")
@Produces("application/octet-stream")
public javax.activation.DataHandler downloadChunk(@QueryParam("docId")
                                                  long docId,
                                                  @QueryParam("version")
                                                  String version,
                                                  @QueryParam("start")
                                                  long start,
                                                  @QueryParam("length")
                                                  long length)
                                           throws Exception

Specified by:

downloadChunk in interface EnterpriseDocumentService

Throws:

Exception

checkin

@Path("/checkin")
@Consumes("multipart/form-data")
public void checkin(Long docId,
                    String comment,
                    String filename,
                    String releaseStr,
                    com.logicaldoc.webservice.model.WSDocument docVO)
             throws Exception

Description copied from interface: EnterpriseDocumentService

Checks in an existing document with the given identifier to create a new version, it uses the uploaded chunks

Specified by:

checkin in interface EnterpriseDocumentService

Parameters:

docId - The document id

comment - The check in operation comment

filename - The document file name

releaseStr - True if this is a new release(e.g.: 2.0) rather than a subversion(e.g.: 1.1)

docVO - new metadata for the document

Throws:

Exception - error in the server or in the database