com.logicaldoc.web.service

Class DocumentServiceImpl

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

com.logicaldoc.web.service.DocumentServiceImpl

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, DocumentService, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class DocumentServiceImpl
extends com.google.gwt.user.server.rpc.RemoteServiceServlet
implements DocumentService

Implementation of the DocumentService

Since:

6.0

Author:

Matteo Caruso - Logical Objects

See Also:

Serialized Form

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

Constructors

Constructor and Description
DocumentServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBookmarks(String sid, long[] ids, int type) Adds new bookmarks
void	addDocuments(String sid, String encoding, boolean importZip, GUIDocument metadata) Adds new documents previously uploaded, with metadata specification.
void	addDocuments(String sid, String language, long folderId, String encoding, boolean importZip, Long templateId) Adds new documents previously uploaded
long	addNote(String sid, long docId, String message) Adds a new document note on the given document
void	bulkUpdate(String sid, long[] ids, GUIDocument vo) Applies to a selection of documents all the given data.
GUIDocument	checkin(String sid, GUIDocument document, boolean major) Checks-in a new document version
void	checkout(String sid, long docId) Checks out the document
protected void	checkPublished(User user, Document doc)
void	cleanUploadedFileFolder(String sid) Cleans the uploaded files folder.
GUIDocument	createEmpty(String sid, GUIDocument vo) Creates a new empty document
void	delete(String sid, long[] ids) Deletes a selection of documents
void	deleteBookmarks(String sid, long[] bookmarkIds) Deletes a set of bookmarks
void	deleteLinks(String sid, long[] ids) Deletes a selection of links
void	deleteNotes(String sid, long[] ids) Deletes a selection of document notes
GUIDocument	deleteVersions(String sid, long[] ids) Deletes a selection of versions
static GUIDocument	fromDocument(Document doc, GUIFolder folder)
GUIExtendedAttribute[]	getAttributes(String sid, long templateId) Retrieves all attributes of the specified template
GUIDocument	getById(String sid, long docId) Retrieves a specific document by its ID
GUIRating	getRating(String sid, long docId) Retrieves the rating of the given document.
GUIVersion[]	getVersionsById(String sid, long id1, long id2) Retrieves two specific versions by its ID
void	linkDocuments(String sid, long[] inDocIds, long[] outDocIds) Links a set of documents
void	lock(String sid, long[] docIds, String comment) Locks a set of documents
void	makeImmutable(String sid, long[] docIds, String comment) Makes immutable a set of documents
void	markHistoryAsRead(String sid, String event) Marks as read the histories related to the current user and the given event.
void	markIndexable(String sid, long[] docIds) Marks a set of documents as indexable
void	markUnindexable(String sid, long[] docIds) Marks a set of documents as unindexable
void	restore(String sid, long docId, long folderId) Restores a given document
GUIDocument	save(String sid, GUIDocument document) Saves the document in the DB
int	saveRating(String sid, GUIRating rating) Save a rating vote on a document.
String	sendAsEmail(String sid, GUIEmail email) Sends a document as email(attachment or download ticket)
protected Document	toDocument(GUIDocument document) Produces a plain new Document from a GUIDocument
void	unlock(String sid, long[] docIds) Unlocks a set of documents
void	updateBookmark(String sid, GUIBookmark bookmark) Updates a single bookmark's data
void	updateLink(String sid, long id, String type) Updates the links type
void	updateNote(String sid, long docId, long noteId, String message) Updates a document note on the given document

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, doGetSerializationPolicy, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, doUnexpectedFailure, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentServiceImpl

public DocumentServiceImpl()

Method Detail

addBookmarks

public void addBookmarks(String sid,
                long[] ids,
                int type)
                  throws InvalidSessionException

Description copied from interface: DocumentService

Adds new bookmarks

Specified by:

addBookmarks in interface DocumentService

Throws:

InvalidSessionException

addDocuments

public void addDocuments(String sid,
                String encoding,
                boolean importZip,
                GUIDocument metadata)
                  throws InvalidSessionException

Description copied from interface: DocumentService

Adds new documents previously uploaded, with metadata specification.

Specified by:

addDocuments in interface DocumentService

Parameters:

sid - The session identifier

encoding - The zip encoding

importZip - If .zip files have to be unpacked and the contained documents imported.

Throws:

InvalidSessionException

addDocuments

public void addDocuments(String sid,
                String language,
                long folderId,
                String encoding,
                boolean importZip,
                Long templateId)
                  throws InvalidSessionException

Description copied from interface: DocumentService

Adds new documents previously uploaded

Specified by:

addDocuments in interface DocumentService

Parameters:

sid - The session identifier

language - The language applied to all documents

folderId - The destination folder identifier

encoding - The zip encoding

importZip - If .zip files have to be unpacked and the contained documents imported

templateId - The documents template

Throws:

InvalidSessionException

checkin

public GUIDocument checkin(String sid,
                  GUIDocument document,
                  boolean major)
                    throws InvalidSessionException

Description copied from interface: DocumentService

Checks-in a new document version

Specified by:

checkin in interface DocumentService

Parameters:

sid - The session identifier

document - The document to update

major - True if this is a major version

Throws:

InvalidSessionException

checkout

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

Description copied from interface: DocumentService

Checks out the document

Specified by:

checkout in interface DocumentService

Throws:

InvalidSessionException

delete

public void delete(String sid,
          long[] ids)
            throws InvalidSessionException

Description copied from interface: DocumentService

Deletes a selection of documents

Specified by:

delete in interface DocumentService

Throws:

InvalidSessionException

deleteBookmarks

public void deleteBookmarks(String sid,
                   long[] bookmarkIds)
                     throws InvalidSessionException

Description copied from interface: DocumentService

Deletes a set of bookmarks

Specified by:

deleteBookmarks in interface DocumentService

Throws:

InvalidSessionException

deleteLinks

public void deleteLinks(String sid,
               long[] ids)
                 throws InvalidSessionException

Description copied from interface: DocumentService

Deletes a selection of links

Specified by:

deleteLinks in interface DocumentService

Throws:

InvalidSessionException

getAttributes

public GUIExtendedAttribute[] getAttributes(String sid,
                                   long templateId)
                                     throws InvalidSessionException

Description copied from interface: DocumentService

Retrieves all attributes of the specified template

Specified by:

getAttributes in interface DocumentService

Throws:

InvalidSessionException

getById

public GUIDocument getById(String sid,
                  long docId)
                    throws InvalidSessionException

Description copied from interface: DocumentService

Retrieves a specific document by its ID

Specified by:

getById in interface DocumentService

Throws:

InvalidSessionException

fromDocument

public static GUIDocument fromDocument(Document doc,
                       GUIFolder folder)

getVersionsById

public GUIVersion[] getVersionsById(String sid,
                           long id1,
                           long id2)
                             throws InvalidSessionException

Description copied from interface: DocumentService

Retrieves two specific versions by its ID

Specified by:

getVersionsById in interface DocumentService

Throws:

InvalidSessionException

linkDocuments

public void linkDocuments(String sid,
                 long[] inDocIds,
                 long[] outDocIds)
                   throws InvalidSessionException

Description copied from interface: DocumentService

Links a set of documents

Specified by:

linkDocuments in interface DocumentService

Throws:

InvalidSessionException

lock

public void lock(String sid,
        long[] docIds,
        String comment)
          throws InvalidSessionException

Description copied from interface: DocumentService

Locks a set of documents

Specified by:

lock in interface DocumentService

Throws:

InvalidSessionException

makeImmutable

public void makeImmutable(String sid,
                 long[] docIds,
                 String comment)
                   throws InvalidSessionException

Description copied from interface: DocumentService

Makes immutable a set of documents

Specified by:

makeImmutable in interface DocumentService

Throws:

InvalidSessionException

markHistoryAsRead

public void markHistoryAsRead(String sid,
                     String event)
                       throws InvalidSessionException

Description copied from interface: DocumentService

Marks as read the histories related to the current user and the given event.

Specified by:

markHistoryAsRead in interface DocumentService

Parameters:

sid - The session identifier

event - The history event to mark as read

Throws:

InvalidSessionException

markIndexable

public void markIndexable(String sid,
                 long[] docIds)
                   throws InvalidSessionException

Description copied from interface: DocumentService

Marks a set of documents as indexable

Specified by:

markIndexable in interface DocumentService

Throws:

InvalidSessionException

markUnindexable

public void markUnindexable(String sid,
                   long[] docIds)
                     throws InvalidSessionException

Description copied from interface: DocumentService

Marks a set of documents as unindexable

Specified by:

markUnindexable in interface DocumentService

Throws:

InvalidSessionException

restore

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

Description copied from interface: DocumentService

Restores a given document

Specified by:

restore in interface DocumentService

Throws:

InvalidSessionException

save

public GUIDocument save(String sid,
               GUIDocument document)
                 throws InvalidSessionException

Description copied from interface: DocumentService

Saves the document in the DB

Specified by:

save in interface DocumentService

document - The document to save

Returns:

The saved document

Throws:

InvalidSessionException

toDocument

protected Document toDocument(GUIDocument document)

Produces a plain new Document from a GUIDocument

sendAsEmail

public String sendAsEmail(String sid,
                 GUIEmail email)
                   throws InvalidSessionException

Description copied from interface: DocumentService

Sends a document as email(attachment or download ticket)

Specified by:

sendAsEmail in interface DocumentService

Returns:

"ok" otherwise an error code

Throws:

InvalidSessionException

unlock

public void unlock(String sid,
          long[] docIds)
            throws InvalidSessionException

Description copied from interface: DocumentService

Unlocks a set of documents

Specified by:

unlock in interface DocumentService

Throws:

InvalidSessionException

updateBookmark

public void updateBookmark(String sid,
                  GUIBookmark bookmark)
                    throws InvalidSessionException

Description copied from interface: DocumentService

Updates a single bookmark's data

Specified by:

updateBookmark in interface DocumentService

Throws:

InvalidSessionException

updateLink

public void updateLink(String sid,
              long id,
              String type)
                throws InvalidSessionException

Description copied from interface: DocumentService

Updates the links type

Specified by:

updateLink in interface DocumentService

Parameters:

sid - The session identifier

id - The link identifier

type - The new type to be set

Throws:

InvalidSessionException

cleanUploadedFileFolder

public void cleanUploadedFileFolder(String sid)
                             throws InvalidSessionException

Description copied from interface: DocumentService

Cleans the uploaded files folder.

Specified by:

cleanUploadedFileFolder in interface DocumentService

Throws:

InvalidSessionException

getRating

public GUIRating getRating(String sid,
                  long docId)
                    throws InvalidSessionException

Description copied from interface: DocumentService

Retrieves the rating of the given document.

Specified by:

getRating in interface DocumentService

Throws:

InvalidSessionException

saveRating

public int saveRating(String sid,
             GUIRating rating)
               throws InvalidSessionException

Description copied from interface: DocumentService

Save a rating vote on a document.

Specified by:

saveRating in interface DocumentService

Returns:

the new document rating value

Throws:

InvalidSessionException

addNote

public long addNote(String sid,
           long docId,
           String message)
             throws InvalidSessionException

Description copied from interface: DocumentService

Adds a new document note on the given document

Specified by:

addNote in interface DocumentService

Throws:

InvalidSessionException

deleteNotes

public void deleteNotes(String sid,
               long[] ids)
                 throws InvalidSessionException

Description copied from interface: DocumentService

Deletes a selection of document notes

Specified by:

deleteNotes in interface DocumentService

Throws:

InvalidSessionException

bulkUpdate

public void bulkUpdate(String sid,
              long[] ids,
              GUIDocument vo)
                throws InvalidSessionException

Description copied from interface: DocumentService

Applies to a selection of documents all the given data.

Specified by:

bulkUpdate in interface DocumentService

Throws:

InvalidSessionException

checkPublished

protected void checkPublished(User user,
                  Document doc)
                       throws Exception

Throws:

Exception

updateNote

public void updateNote(String sid,
              long docId,
              long noteId,
              String message)
                throws InvalidSessionException

Description copied from interface: DocumentService

Updates a document note on the given document

Specified by:

updateNote in interface DocumentService

Throws:

InvalidSessionException

deleteVersions

public GUIDocument deleteVersions(String sid,
                         long[] ids)
                           throws InvalidSessionException

Description copied from interface: DocumentService

Deletes a selection of versions

Specified by:

deleteVersions in interface DocumentService

Throws:

InvalidSessionException

createEmpty

public GUIDocument createEmpty(String sid,
                      GUIDocument vo)
                        throws InvalidSessionException

Description copied from interface: DocumentService

Creates a new empty document

Specified by:

createEmpty in interface DocumentService

Throws:

InvalidSessionException