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 final 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)
     
    com.logicaldoc.webservice.model.WSDocument
    merge(String sid, List<Long> docIds, long targetFolderId, String filename)
    Merges a set of documents into a single PDF
    void
    uploadChunk(String sid, javax.activation.DataHandler content)
     

    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

  • Field Details

    • CHUNK_NUMBER_FORMAT

      public static final NumberFormat CHUNK_NUMBER_FORMAT

  • Constructor Details

    • SoapEnterpriseDocumentService

      public SoapEnterpriseDocumentService()

  • 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

    • 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 documentVO) 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)
      documentVO - 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, 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

    • merge

      public com.logicaldoc.webservice.model.WSDocument merge(String sid, List<Long> docIds, long targetFolderId, 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:
      sid - Session identifier
      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