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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RestEnterpriseDocumentService.EntepriseCheckinDocumentMultipartRequest

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, boolean release, 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
jakarta.activation.DataHandler	downloadChunk(long docId, String version, long start, long length)
com.logicaldoc.webservice.model.WSDocument	merge(List<Long> docIds, long targetFolderId, String filename)	Merges a set of documents into a single PDF
void	uploadChunk(byte[] messageBody)
void	uploadChunkIS(InputStream is)

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

checkin, create, deleteChunks, downloadChunk, merge, uploadChunk

Methods inherited from class com.logicaldoc.webservice.AbstractService

convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession

Methods inherited from class java.lang.Object

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

Constructor Details

RestEnterpriseDocumentService

public RestEnterpriseDocumentService()

Method Details

uploadChunk

@POST
@Path("/uploadChunk")
@Consumes("application/octet-stream")
public void uploadChunk(byte[] messageBody)
                 throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Specified by:

uploadChunk in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

uploadChunkIS

@POST
@Path("/uploadChunkIS")
@Consumes("application/octet-stream")
public void uploadChunkIS(InputStream is)
                   throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Specified by:

uploadChunkIS in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

deleteChunks

@DELETE
@Path("/deleteChunks")
public void deleteChunks()
                  throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Description copied from interface: EnterpriseDocumentService

Deletes all the chunks in the current upload session

Specified by:

deleteChunks in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.PersistenceException - Error in the database layer

IOException - I/O error

create

@POST
@Path("/create")
public com.logicaldoc.webservice.model.WSDocument create(com.logicaldoc.webservice.model.WSDocument document)
                                                  throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

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:

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.PersistenceException - Error in the database layer

IOException - I/O error

downloadChunk

@GET
@Path("/downloadChunk")
@Produces("application/octet-stream")
public jakarta.activation.DataHandler downloadChunk(@QueryParam("docId")
 long docId,
 @QueryParam("version")
 String version,
 @QueryParam("start")
 long start,
 @QueryParam("length")
 long length)
                                             throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException,
com.logicaldoc.core.security.authorization.PermissionException

Specified by:

downloadChunk in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

com.logicaldoc.core.security.authorization.PermissionException

checkin

@POST
@Path("/checkin")
@Consumes("multipart/form-data")
public void checkin(Long docId,
 String comment,
 String filename,
 boolean release,
 com.logicaldoc.webservice.model.WSDocument docVO)
             throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

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

release - 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:

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.PersistenceException - Error in the database layer

IOException - I/O error

merge

@POST
@Path("/merge")
@Produces({"application/json","application/xml"})
public com.logicaldoc.webservice.model.WSDocument merge(@QueryParam("docIds")
 List<Long> docIds,
 @QueryParam("targetFolderId")
 long targetFolderId,
 @QueryParam("filename")
 String filename)
                                                 throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
IOException,
com.logicaldoc.core.security.authorization.PermissionException,
com.logicaldoc.core.security.authorization.UnexistingResourceException

Description copied from interface: EnterpriseDocumentService

Merges a set of documents into a single PDF

Specified by:

merge in interface EnterpriseDocumentService

Parameters:

docIds - identifiers of the documents to merge

targetFolderId - identifier of the folder that will receive the merged PDF

filename - file name of the merged PDF

Returns:

the newly created merged document

Throws:

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

IOException - I/O error

com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions

com.logicaldoc.core.security.authorization.UnexistingResourceException - Ome of the referenced documents do not exist