Package com.logicaldoc.enterprise.webservice.soap.client

Class SoapEnterpriseDocumentClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<EnterpriseDocumentService>

com.logicaldoc.enterprise.webservice.soap.client.SoapEnterpriseDocumentClient

All Implemented Interfaces:

EnterpriseDocumentService

public class SoapEnterpriseDocumentClient
extends com.logicaldoc.webservice.soap.client.SoapClient<EnterpriseDocumentService>
implements EnterpriseDocumentService

Enterprise Document Web Service client.

Since:

8.1.2

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapEnterpriseDocumentClient(String endpoint)
SoapEnterpriseDocumentClient(String endpoint, int timeout)

Method Summary

Modifier and Type	Method	Description
void	checkin(String sid, 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(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, File chunk)
void	uploadChunk(String sid, javax.activation.DataHandler content)
void	uploadChunks(String sid, File file, long chunkSize)	Uploads big file in chunks

Methods inherited from class java.lang.Object

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

Constructor Details

SoapEnterpriseDocumentClient

public SoapEnterpriseDocumentClient(String endpoint)
                             throws IOException

Throws:

IOException

SoapEnterpriseDocumentClient

public SoapEnterpriseDocumentClient(String endpoint,
 int timeout)
                             throws IOException

Throws:

IOException

Method Details

uploadChunk

public void uploadChunk(String sid,
 javax.activation.DataHandler content)
                 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

uploadChunk

public void uploadChunk(String sid,
 File chunk)
                 throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

uploadChunks

public void uploadChunks(String sid,
 File file,
 long chunkSize)
                  throws IOException,
com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Uploads big file in chunks

Parameters:

sid - identifier of the session

file - The original file

chunkSize - Max size of a chunk in bytes

Throws:

IOException - I/O error

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

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

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

deleteChunks

public void deleteChunks(String sid)
                  throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Specified by:

deleteChunks in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException

create

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

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:

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

checkin

public void checkin(String sid,
 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:

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)

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

downloadChunk

public javax.activation.DataHandler downloadChunk(String sid,
 long docId,
 String version,
 long start,
 long length)
                                           throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Specified by:

downloadChunk in interface EnterpriseDocumentService

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException

IOException