com.logicaldoc.webservice.document

Class DocumentClient

java.lang.Object

com.logicaldoc.webservice.AbstractClient<DocumentService>

com.logicaldoc.webservice.document.DocumentClient

All Implemented Interfaces:

DocumentService

public class DocumentClient
extends AbstractClient<DocumentService>
implements DocumentService

Document Web Service client.

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.webservice.AbstractClient

client, endpoint

Constructor Summary

Constructors

Constructor and Description
DocumentClient(String endpoint)
DocumentClient(String endpoint, int gzipThreshold, boolean log, int timeout)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkin(String sid, long docId, String comment, String filename, boolean release, DataHandler content) Checks in an existing document with the given identifier to create a new version.
void	checkin(String sid, long docId, String comment, String filename, boolean release, File content)
void	checkout(String sid, long docId) Checkouts an existing document with the given identifier.
WSDocument	create(String sid, WSDocument document, DataHandler content) Create a new document.
WSDocument	create(String sid, WSDocument document, File content)
WSDocument	createAlias(String sid, long docId, long folderId) Create a new document alias for the given document id and inside the given folder id.
void	delete(String sid, long docId) Deletes an existing document with the given identifier.
WSDocument[]	getAliases(String sid, long docId) Gets the aliases of the given document
DataHandler	getContent(String sid, long docId) Gets the document content of an existing document with the given identifier.
WSDocument	getDocument(String sid, long docId) Gets document metadata of an existing document with the given identifier.
WSDocument	getDocumentByCustomId(String sid, String customId) Gets document metadata of an existing document with the given custom identifier.
WSDocument[]	getDocuments(String sid, Long[] docIds) Gets document metadata of a collection of existing documents with the given identifiers.
WSDocument[]	getRecentDocuments(String sid, Integer max) Lists of last modified documents of the current session's user.
DataHandler	getVersionContent(String sid, long docId, String version) Gets the document content of an existing document with the given identifier.
WSDocument[]	getVersions(String sid, long docId) Gets the version history of an existing document with the given identifier.
boolean	isReadable(String sid, long docId) Test if a document identifier is valid.
WSDocument[]	list(String sid, long folderId) Deprecated.
WSDocument[]	listDocuments(String sid, long folderId, String fileName) Gets a document in a specific folder
void	lock(String sid, long docId) Locks an existing document with the given identifier.
void	move(String sid, long docId, long folderId) Moves an existing document with the given identifier.
void	reindex(String sid, long docId) Reindexes(or indexes) a document
void	rename(String sid, long docId, String name) Renames the title of an existing document with the given identifier.
void	renameFile(String sid, long docId, String name) Renames the filename of an existing document with the given identifier.
void	restore(String sid, long docId, long folderId) Restores an existing document with the given identifier.
void	sendEmail(String sid, Long[] docIds, String recipients, String subject, String message) Sends a set of documents as mail attachments
void	unlock(String sid, long docId) Unlocks an existing document with the given identifier.
void	update(String sid, WSDocument document) Updates an existing document with the value object containing the document's metadata.

Methods inherited from class com.logicaldoc.webservice.AbstractClient

configureSSL, configureTimeout, initClient

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentClient

public DocumentClient(String endpoint,
              int gzipThreshold,
              boolean log,
              int timeout)
               throws IOException

Throws:

IOException

DocumentClient

public DocumentClient(String endpoint)
               throws IOException

Throws:

IOException

Method Detail

create

public WSDocument create(String sid,
                WSDocument document,
                DataHandler content)
                  throws Exception

Description copied from interface: DocumentService

Create a new document. The user can completely customize the document through a value object containing the document's metadata.

Specified by:

create in interface DocumentService

Parameters:

sid - Session identifier

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

content - The document's binary content

Returns:

The value object containing the document's metadata.

Throws:

Exception

create

public WSDocument create(String sid,
                WSDocument document,
                File content)
                  throws Exception

Throws:

Exception

checkout

public void checkout(String sid,
            long docId)
              throws Exception

Description copied from interface: DocumentService

Checkouts an existing document with the given identifier.

Specified by:

checkout in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

delete

public void delete(String sid,
          long docId)
            throws Exception

Description copied from interface: DocumentService

Deletes an existing document with the given identifier.

Specified by:

delete in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

getDocument

public WSDocument getDocument(String sid,
                     long docId)
                       throws Exception

Description copied from interface: DocumentService

Gets document metadata of an existing document with the given identifier.

Specified by:

getDocument in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Returns:

A value object containing the document's metadata.

Throws:

Exception

getDocumentByCustomId

public WSDocument getDocumentByCustomId(String sid,
                               String customId)
                                 throws Exception

Description copied from interface: DocumentService

Gets document metadata of an existing document with the given custom identifier.

Specified by:

getDocumentByCustomId in interface DocumentService

Parameters:

sid - Session identifier

customId - The custom id

Returns:

A value object containing the document's metadata.

Throws:

Exception

isReadable

public boolean isReadable(String sid,
                 long docId)
                   throws Exception

Description copied from interface: DocumentService

Test if a document identifier is valid.

Specified by:

isReadable in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Returns:

True if the identifier denotes a document, otherwise false.

Throws:

Exception

lock

public void lock(String sid,
        long docId)
          throws Exception

Description copied from interface: DocumentService

Locks an existing document with the given identifier.

Specified by:

lock in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

move

public void move(String sid,
        long docId,
        long folderId)
          throws Exception

Description copied from interface: DocumentService

Moves an existing document with the given identifier.

Specified by:

move in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

folderId - The folder id of the new document folder

Throws:

Exception

unlock

public void unlock(String sid,
          long docId)
            throws Exception

Description copied from interface: DocumentService

Unlocks an existing document with the given identifier.

Specified by:

unlock in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

update

public void update(String sid,
          WSDocument document)
            throws Exception

Description copied from interface: DocumentService

Updates an existing document with the value object containing the document's metadata.

Specified by:

update in interface DocumentService

Parameters:

sid - Session identifier

Throws:

Exception

checkin

public void checkin(String sid,
           long docId,
           String comment,
           String filename,
           boolean release,
           DataHandler content)
             throws Exception

Description copied from interface: DocumentService

Checks in an existing document with the given identifier to create a new version.

Specified by:

checkin in interface DocumentService

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(eg: 2.0) rather than a subversion(eg: 1.1)

content - The document's binary content

Throws:

Exception

checkin

public void checkin(String sid,
           long docId,
           String comment,
           String filename,
           boolean release,
           File content)
             throws Exception

Throws:

Exception

list

@Deprecated
public WSDocument[] list(String sid,
                           long folderId)
                  throws Exception

Deprecated.

Description copied from interface: DocumentService

Lists the documents inside a folder

Specified by:

list in interface DocumentService

Parameters:

sid - Session identifier

folderId - The document id

Returns:

Array of documents contained in the folder

Throws:

Exception

getContent

public DataHandler getContent(String sid,
                     long docId)
                       throws Exception

Description copied from interface: DocumentService

Gets the document content of an existing document with the given identifier.

Specified by:

getContent in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Returns:

The requested document's binary

Throws:

Exception

getVersionContent

public DataHandler getVersionContent(String sid,
                            long docId,
                            String version)
                              throws Exception

Description copied from interface: DocumentService

Gets the document content of an existing document with the given identifier.

Specified by:

getVersionContent in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

version - The specific version(it can be empty)

Returns:

The requested document's binary

Throws:

Exception

getVersions

public WSDocument[] getVersions(String sid,
                       long docId)
                         throws Exception

Description copied from interface: DocumentService

Gets the version history of an existing document with the given identifier.

Specified by:

getVersions in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Returns:

Array of versions

Throws:

Exception

restore

public void restore(String sid,
           long docId,
           long folderId)
             throws Exception

Description copied from interface: DocumentService

Restores an existing document with the given identifier.

Specified by:

restore in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

folderId - The target folder id

Throws:

Exception

rename

public void rename(String sid,
          long docId,
          String name)
            throws Exception

Description copied from interface: DocumentService

Renames the title of an existing document with the given identifier.

Specified by:

rename in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

name - The new document title

Throws:

Exception

getDocuments

public WSDocument[] getDocuments(String sid,
                        Long[] docIds)
                          throws Exception

Description copied from interface: DocumentService

Gets document metadata of a collection of existing documents with the given identifiers.

Specified by:

getDocuments in interface DocumentService

Parameters:

sid - Session identifier

docIds - The documents ids

Returns:

A value object containing the document's metadata.

Throws:

Exception

getRecentDocuments

public WSDocument[] getRecentDocuments(String sid,
                              Integer max)
                                throws Exception

Description copied from interface: DocumentService

Lists of last modified documents of the current session's user.

Specified by:

getRecentDocuments in interface DocumentService

Parameters:

sid - Session identifier

max - Maximum number of returned records

Returns:

Array of documents

Throws:

Exception

sendEmail

public void sendEmail(String sid,
             Long[] docIds,
             String recipients,
             String subject,
             String message)
               throws Exception

Description copied from interface: DocumentService

Sends a set of documents as mail attachments

Specified by:

sendEmail in interface DocumentService

Parameters:

sid - Session identifiers

docIds - Set of document ids

recipients - Set of recipients(comma separated)

subject - The email subject

message - The email message body

Throws:

Exception

createAlias

public WSDocument createAlias(String sid,
                     long docId,
                     long folderId)
                       throws Exception

Description copied from interface: DocumentService

Create a new document alias for the given document id and inside the given folder id.

Specified by:

createAlias in interface DocumentService

Parameters:

sid - Session identifier

docId - The original document id

folderId - Identifier of the folder in which will be stored the alias.

Returns:

The value object containing the document's metadata.

Throws:

Exception

renameFile

public void renameFile(String sid,
              long docId,
              String name)
                throws Exception

Description copied from interface: DocumentService

Renames the filename of an existing document with the given identifier.

Specified by:

renameFile in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

name - The new document file name

Throws:

Exception

reindex

public void reindex(String sid,
           long docId)
             throws Exception

Description copied from interface: DocumentService

Reindexes(or indexes) a document

Specified by:

reindex in interface DocumentService

Parameters:

sid - Session identifier

docId - The document id

Throws:

Exception

listDocuments

public WSDocument[] listDocuments(String sid,
                         long folderId,
                         String fileName)
                           throws Exception

Description copied from interface: DocumentService

Gets a document in a specific folder

Specified by:

listDocuments in interface DocumentService

Parameters:

sid - Session identifier

folderId - The folder id

fileName - Optional file name filter

Returns:

A value object containing the document's metadata.

Throws:

Exception

getAliases

public WSDocument[] getAliases(String sid,
                      long docId)
                        throws Exception

Description copied from interface: DocumentService

Gets the aliases of the given document

Specified by:

getAliases in interface DocumentService

Parameters:

sid - Session identifier

docId - The master document ID

Returns:

Arrays of aliases

Throws:

Exception