Package com.logicaldoc.enterprise.webservice.soap.endpoint

Class SoapEnterpriseDocumentService

java.lang.Object

com.logicaldoc.webservice.AbstractService

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

All Implemented Interfaces:

EnterpriseDocumentService

Direct Known Subclasses:

RestEnterpriseDocumentService

public class SoapEnterpriseDocumentService
extends com.logicaldoc.webservice.AbstractService
implements EnterpriseDocumentService

Enterprise Document Web Service Implementation (SOAP)

Since:

8.1.2

Author:

Marco Meschieri - LogicalDOC

Field Summary

Fields

Modifier and Type	Field	Description
static NumberFormat	CHUNK_NUMBER_FORMAT

Constructor Summary

Constructors

Constructor	Description
SoapEnterpriseDocumentService()

Method Summary

Modifier and Type	Method	Description
void	checkin(String sid, long docId, String comment, String filename, boolean release, com.logicaldoc.webservice.model.WSDocument documentVO)	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(String sid, com.logicaldoc.webservice.model.WSDocument document)	Creates a new document using the uploaded chunks.
void	deleteChunks(String sid)
javax.activation.DataHandler	downloadChunk(String sid, long docId, String version, long start, long length)
void	uploadChunk(String sid, javax.activation.DataHandler content)

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

Field Detail

CHUNK_NUMBER_FORMAT

public static final NumberFormat CHUNK_NUMBER_FORMAT

Constructor Detail

SoapEnterpriseDocumentService

public SoapEnterpriseDocumentService()

Method Detail

uploadChunk

public void uploadChunk(String sid,
                        javax.activation.DataHandler content)
                 throws Exception

Specified by:

uploadChunk in interface EnterpriseDocumentService

Throws:

Exception

deleteChunks

public void deleteChunks(String sid)
                  throws Exception

Specified by:

deleteChunks in interface EnterpriseDocumentService

Throws:

Exception

create

public com.logicaldoc.webservice.model.WSDocument create(String sid,
                                                         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:

sid - identifier of the session

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

checkin

public void checkin(String sid,
                    long docId,
                    String comment,
                    String filename,
                    boolean release,
                    com.logicaldoc.webservice.model.WSDocument documentVO)
             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:

sid - Session identifier

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)

documentVO - new metadata for the document

Throws:

Exception - error in the server or in the database

downloadChunk

public javax.activation.DataHandler downloadChunk(String sid,
                                                  long docId,
                                                  String version,
                                                  long start,
                                                  long length)
                                           throws Exception

Specified by:

downloadChunk in interface EnterpriseDocumentService

Throws:

Exception