Class RestDocumentService
- java.lang.Object
-
- com.logicaldoc.webservice.AbstractService
-
- com.logicaldoc.webservice.soap.endpoint.SoapDocumentService
-
- com.logicaldoc.webservice.rest.endpoint.RestDocumentService
-
- All Implemented Interfaces:
DocumentService,DocumentService
- Direct Known Subclasses:
RestDocumentSwagger
@Path("/") @Consumes({"application/xml","application/json"}) @Produces("application/json") public class RestDocumentService extends SoapDocumentService implements DocumentService
-
-
Constructor Summary
Constructors Constructor Description RestDocumentService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WSNoteaddNote(long docId, String note)Adds a new note for the given documentjavax.ws.rs.core.Responsecheckin(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)voidcheckout(long docId)javax.ws.rs.core.Responsecreate(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts)WSDocumentcreateAlias(long docId, long folderId, String type)Creates a new document alias for the given document inside a specified folderStringcreateDownloadTicket(long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads)Creates a new download ticketvoidcreatePdf(long docId, String fileVersion)Creates the PDF conversion of the given document; if the PDF conversion was already created, nothing will happenvoidcreateThumbnail(long docId, String fileVersion)Creates the thumbail of the given document; if the thumbnail was already created, nothing will happenvoiddelete(long docId)voiddeleteLink(long id)Removes an existing linkvoiddeleteNote(long noteId)Adds a new note for the given documentStringdeleteVersion(long docId, String version)Deletes a version by document identifier and version ID.WSDocument[]getAliases(long docId)Gets the aliases of the given documentjavax.activation.DataHandlergetContent(long docId)WSDocumentgetDocument(long docId)WSDocumentgetDocumentByCustomId(String customId)Gets document metadata of an existing document with the given custom identifierWSDocument[]getDocuments(Long[] docIds)Gets document metadata of a collection of existing documents with the given identifiersStringgetExtractedText(long docId)Gets the document's text stored in the full-text indexWSLink[]getLinks(long docId)Gets all the links of a specific documentWSNote[]getNotes(long docId)Gets the notes for the given documentWSRating[]getRatings(long docId)Gets all the ratings of the given documentWSDocument[]getRecentDocuments(Integer maxHits)Lists of last modified documents of the current sessionjavax.activation.DataHandlergetResource(long docId, String fileVersion, String suffix)Gets the content of a resource associated to the given document.javax.activation.DataHandlergetVersionContent(long docId, String version)WSDocument[]getVersions(long docId)Gets the version history of an existing document with the given identifierbooleanisReadable(long docId)Tests if a document is readableWSLinklink(long doc1, long doc2, String type)Creates a new link between two documents.WSDocument[]list(long folderId)WSDocument[]listDocuments(long folderId, String fileName)voidlock(long docId)Locks an existing document with the given identifier.voidmove(long docId, long folderId)Moves an existing document with the given identifiervoidpromoteVersion(long docId, String version)Promotes an old version to the current default one.WSRatingrateDocument(long docId, int vote)Puts a new rating on the given documentvoidreindex(long docId, String content)Re-indexes(or indexes from scratch) a documentvoidrename(long docId, String name)Renames the title of an existing document with the given identifier.javax.ws.rs.core.ResponsereplaceFile(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)voidrestore(long docId, long folderId)Restores a deleted documentWSNotesaveNote(long docId, WSNote note)Adds a new note for the given documentvoidsendEmail(Long[] docIds, String recipients, String subject, String message)Sends a set of documents as mail attachmentsvoidsetPassword(long docId, String password)Puts a password protection to the documentvoidunlock(long docId)Unlocks an existing document with the given identifier.booleanunprotect(long docId, String password)Unprotects a document that is password protected.voidunsetPassword(long docId, String currentPassword)Removes the password protection from the documentvoidupdate(WSDocument document)Updates an existing document with the value object containing the document's metadata.javax.ws.rs.core.Responseupload(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)voiduploadResource(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments)Uploads a new resource attached to the given document.-
Methods inherited from class com.logicaldoc.webservice.soap.endpoint.SoapDocumentService
addNote, checkin, checkin, checkinDocument, checkinDocument, checkout, create, create, createAlias, createDownloadTicket, createPdf, createThumbnail, delete, deleteLink, deleteNote, deleteVersion, getAliases, getContent, getDocument, getDocumentByCustomId, getDocuments, getExtractedText, getLinks, getNotes, getRatings, getRecentDocuments, getResource, getVersionContent, getVersions, isReadable, link, listDocuments, lock, move, promoteVersion, rateDocument, reindex, rename, replaceFile, restore, saveNote, sendEmail, setPassword, unlock, unprotect, unsetPassword, update, upload, uploadResource
-
Methods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getContext, getMessageContext, isValidateSession, setContext, setMessageContext, setValidateSession
-
-
-
-
Method Detail
-
create
@POST @Path("/create") @Consumes("multipart/form-data") public javax.ws.rs.core.Response create(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> atts) throws Exception- Specified by:
createin interfaceDocumentService- Throws:
Exception
-
getDocument
@GET @Path("/getDocument") @Produces({"application/json","application/xml"}) public WSDocument getDocument(@QueryParam("docId") long docId) throws Exception- Specified by:
getDocumentin interfaceDocumentService- Throws:
Exception
-
checkout
@POST @Path("/checkout") @Consumes("application/x-www-form-urlencoded") public void checkout(@FormParam("docId") long docId) throws Exception- Specified by:
checkoutin interfaceDocumentService- Throws:
Exception
-
checkin
@POST @Path("/checkin") @Consumes("multipart/form-data") @Produces({"text/plain","application/json","application/xml"}) public javax.ws.rs.core.Response checkin(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments) throws Exception- Specified by:
checkinin interfaceDocumentService- Throws:
Exception
-
upload
@POST @Path("/upload") @Consumes("multipart/form-data") @Produces({"text/plain","application/json","application/xml"}) public javax.ws.rs.core.Response upload(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments) throws Exception- Specified by:
uploadin interfaceDocumentService- Throws:
Exception
-
replaceFile
@POST @Path("/replaceFile") @Consumes("multipart/form-data") @Produces({"text/plain","application/json","application/xml"}) public javax.ws.rs.core.Response replaceFile(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments) throws Exception- Specified by:
replaceFilein interfaceDocumentService- Throws:
Exception
-
delete
@DELETE @Path("/delete") public void delete(@QueryParam("docId") long docId) throws Exception- Specified by:
deletein interfaceDocumentService- Throws:
Exception
-
list
@GET @Path("/list") @Produces("application/json") public WSDocument[] list(@QueryParam("folderId") long folderId) throws Exception- Specified by:
listin interfaceDocumentService- Throws:
Exception
-
listDocuments
@GET @Path("/listDocuments") public WSDocument[] listDocuments(@QueryParam("folderId") long folderId, @QueryParam("fileName") String fileName) throws Exception- Specified by:
listDocumentsin interfaceDocumentService- Throws:
Exception
-
getContent
@GET @Path("/getContent") @Produces("application/octet-stream") public javax.activation.DataHandler getContent(@QueryParam("docId") long docId) throws Exception- Specified by:
getContentin interfaceDocumentService- Throws:
Exception
-
getVersionContent
@GET @Path("/getVersionContent") @Produces("application/octet-stream") public javax.activation.DataHandler getVersionContent(@QueryParam("docId") long docId, @QueryParam("version") String version) throws Exception- Specified by:
getVersionContentin interfaceDocumentService- Throws:
Exception
-
deleteVersion
@DELETE @Path("/deleteVersion") public String deleteVersion(@QueryParam("docId") long docId, @QueryParam("version") String version) throws ExceptionDescription copied from interface:DocumentServiceDeletes a version by document identifier and version ID. You can not delete the latest version of a document- Specified by:
deleteVersionin interfaceDocumentService- Parameters:
docId- identifier of the documentversion- the document's version- Returns:
- the latest version of the document
- Throws:
Exception- error in the server application
-
update
@PUT @Path("/update") public void update(WSDocument document) throws ExceptionDescription copied from interface:DocumentServiceUpdates an existing document with the value object containing the document's metadata.- Specified by:
updatein interfaceDocumentService- Parameters:
document- the document to update- Throws:
Exception- error in the server application
-
addNote
@POST @Path("/addNote") @Consumes("application/x-www-form-urlencoded") public WSNote addNote(@FormParam("docId") long docId, @FormParam("note") String note) throws ExceptionDescription copied from interface:DocumentServiceAdds a new note for the given document- Specified by:
addNotein interfaceDocumentService- Parameters:
docId- identifier of the documentnote- the note to add- Returns:
- the added note
- Throws:
Exception- error in the server application
-
deleteNote
@DELETE @Path("/deleteNote") public void deleteNote(@QueryParam("noteId") long noteId) throws ExceptionAdds a new note for the given document- Specified by:
deleteNotein interfaceDocumentService- Parameters:
noteId- identifier of the note- Throws:
Exception- error in the server application
-
getNotes
@GET @Path("/getNotes") public WSNote[] getNotes(@QueryParam("docId") long docId) throws ExceptionGets the notes for the given document- Specified by:
getNotesin interfaceDocumentService- Parameters:
docId- identifier of the document- Returns:
- array of notes
- Throws:
Exception- error in the server application
-
rateDocument
@PUT @Path("/rateDocument") public WSRating rateDocument(@QueryParam("docId") long docId, @QueryParam("vote") int vote) throws ExceptionPuts a new rating on the given document- Specified by:
rateDocumentin interfaceDocumentService- Parameters:
docId- identifier of the documentvote- the vote- Returns:
- the rating
- Throws:
Exception- error in the server application
-
getRatings
@GET @Path("/getRatings") public WSRating[] getRatings(@QueryParam("docId") long docId) throws ExceptionGets all the ratings of the given document- Specified by:
getRatingsin interfaceDocumentService- Parameters:
docId- identifier of the document- Returns:
- the ratings
- Throws:
Exception- error in the server application
-
move
@PUT @Path("/move") public void move(@QueryParam("docId") long docId, @QueryParam("folderId") long folderId) throws ExceptionDescription copied from interface:DocumentServiceMoves an existing document with the given identifier- Specified by:
movein interfaceDocumentService- Parameters:
docId- The document idfolderId- Identifier of the new document's folder- Throws:
Exception- error in the server application
-
createThumbnail
@PUT @Path("/createThumbnail") public void createThumbnail(@QueryParam("docId") long docId, @QueryParam("fileVersion") String fileVersion) throws ExceptionDescription copied from interface:DocumentServiceCreates the thumbail of the given document; if the thumbnail was already created, nothing will happen- Specified by:
createThumbnailin interfaceDocumentService- Parameters:
docId- The document idfileVersion- The specific file version(it can be empty)- Throws:
Exception- error in the server application
-
createPdf
@PUT @Path("/createPdf") public void createPdf(@QueryParam("docId") long docId, @QueryParam("fileVersion") String fileVersion) throws ExceptionDescription copied from interface:DocumentServiceCreates the PDF conversion of the given document; if the PDF conversion was already created, nothing will happen- Specified by:
createPdfin interfaceDocumentService- Parameters:
docId- The document idfileVersion- The specific file version(it can be empty)- Throws:
Exception- error in the server application
-
promoteVersion
@PUT @Path("/promoteVersion") public void promoteVersion(@QueryParam("docId") long docId, @QueryParam("version") String version) throws ExceptionDescription copied from interface:DocumentServicePromotes an old version to the current default one. If you promote a prior version, what it does is make it the default version again. (regardless of there being many versions).- Specified by:
promoteVersionin interfaceDocumentService- Parameters:
docId- the document to be updatedversion- the version- Throws:
Exception- if an error occurs, this exception is thrown
-
rename
@PUT @Path("/rename") public void rename(@QueryParam("docId") long docId, @QueryParam("name") String name) throws ExceptionDescription copied from interface:DocumentServiceRenames the title of an existing document with the given identifier.- Specified by:
renamein interfaceDocumentService- Parameters:
docId- The document idname- The new document filename- Throws:
Exception- error in the server application
-
getVersions
@GET @Path("/getVersions") public WSDocument[] getVersions(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceGets the version history of an existing document with the given identifier- Specified by:
getVersionsin interfaceDocumentService- Parameters:
docId- The document id- Returns:
- Array of versions
- Throws:
Exception- error in the server application
-
createAlias
@POST @Path("/createAlias") public WSDocument createAlias(@FormParam("docId") long docId, @FormParam("folderId") long folderId, @FormParam("type") String type) throws ExceptionDescription copied from interface:DocumentServiceCreates a new document alias for the given document inside a specified folder- Specified by:
createAliasin interfaceDocumentService- Parameters:
docId- The original document idfolderId- Identifier of the folder in which will be stored the alias.type- Type of the alias- Returns:
- The value object containing the document's metadata
- Throws:
Exception- error in the server application
-
createDownloadTicket
@POST @Path("/createDownloadTicket") @Consumes("application/x-www-form-urlencoded") public String createDownloadTicket(@FormParam("docId") long docId, @FormParam("suffix") String suffix, @FormParam("expireHours") Integer expireHours, @FormParam("expireDate") String expireDate, @FormParam("maxDownloads") Integer maxDownloads) throws ExceptionDescription copied from interface:DocumentServiceCreates a new download ticket- Specified by:
createDownloadTicketin interfaceDocumentService- Parameters:
docId- identifier of the documentsuffix- can be null or 'conversion.pdf'expireHours- expiration time expressed in hoursexpireDate- exact expiration date expressed in the format yyyy-MM-ddmaxDownloads- maximum number of admitted downloads- Returns:
- the download ticket
- Throws:
Exception- error in the server application
-
deleteLink
@DELETE @Path("/deleteLink") public void deleteLink(@QueryParam("id") long id) throws ExceptionDescription copied from interface:DocumentServiceRemoves an existing link- Specified by:
deleteLinkin interfaceDocumentService- Parameters:
id- ID of the link- Throws:
Exception- error in the server application
-
getAliases
@GET @Path("/getAliases") public WSDocument[] getAliases(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceGets the aliases of the given document- Specified by:
getAliasesin interfaceDocumentService- Parameters:
docId- The master document ID- Returns:
- Arrays of aliases
- Throws:
Exception- error in the server application
-
getDocumentByCustomId
@GET @Path("/getDocumentByCustomId") public WSDocument getDocumentByCustomId(@QueryParam("customId") String customId) throws ExceptionDescription copied from interface:DocumentServiceGets document metadata of an existing document with the given custom identifier- Specified by:
getDocumentByCustomIdin interfaceDocumentService- Parameters:
customId- The custom id- Returns:
- A value object containing the document's metadata
- Throws:
Exception- error in the server application
-
getDocuments
@GET @Path("/getDocuments") public WSDocument[] getDocuments(@QueryParam("docIds") Long[] docIds) throws ExceptionDescription copied from interface:DocumentServiceGets document metadata of a collection of existing documents with the given identifiers- Specified by:
getDocumentsin interfaceDocumentService- Parameters:
docIds- identifiers of the documents- Returns:
- the list of documents
- Throws:
Exception- error in the server application
-
getExtractedText
@GET @Path("/getExtractedText") public String getExtractedText(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceGets the document's text stored in the full-text index- Specified by:
getExtractedTextin interfaceDocumentService- Parameters:
docId- The document id- Returns:
- The requested document's text
- Throws:
Exception- error in the server application
-
getRecentDocuments
@GET @Path("/getRecentDocuments") public WSDocument[] getRecentDocuments(@QueryParam("maxHits") Integer maxHits) throws ExceptionDescription copied from interface:DocumentServiceLists of last modified documents of the current session- Specified by:
getRecentDocumentsin interfaceDocumentService- Parameters:
maxHits- Maximum number of returned records- Returns:
- Array of documents
- Throws:
Exception- error in the server application
-
getLinks
@GET @Path("/getLinks") public WSLink[] getLinks(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceGets all the links of a specific document- Specified by:
getLinksin interfaceDocumentService- Parameters:
docId- ID of the document- Returns:
- The new links of the document
- Throws:
Exception- error in the server application
-
getResource
@GET @Path("/getResource") public javax.activation.DataHandler getResource(@QueryParam("docId") long docId, @QueryParam("fileVersion") String fileVersion, @QueryParam("suffix") String suffix) throws ExceptionDescription copied from interface:DocumentServiceGets the content of a resource associated to the given document.- Specified by:
getResourcein interfaceDocumentService- Parameters:
docId- The document idfileVersion- The specific file version(it can be empty)suffix- Suffix specification(it can be empty, conversion.pdf to get the PDF conversion)- Returns:
- The requested resource's binary
- Throws:
Exception- error in the server application
-
isReadable
@GET @Path("/isReadable") public boolean isReadable(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceTests if a document is readable- Specified by:
isReadablein interfaceDocumentService- Parameters:
docId- The document id- Returns:
- True if the identifier denotes a document, otherwise false
- Throws:
Exception- error in the server application
-
link
@POST @Path("/link") public WSLink link(@FormParam("doc1") long doc1, @FormParam("doc2") long doc2, @FormParam("type") String type) throws ExceptionDescription copied from interface:DocumentServiceCreates a new link between two documents.- Specified by:
linkin interfaceDocumentService- Parameters:
doc1- ID of document 1doc2- ID of document 2type- The link type(it can be empty)- Returns:
- the new link
- Throws:
Exception- error in the server application
-
lock
@PUT @Path("/lock") public void lock(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceLocks an existing document with the given identifier.- Specified by:
lockin interfaceDocumentService- Parameters:
docId- The document id- Throws:
Exception- error in the server application
-
reindex
@POST @Path("/reindex") @Consumes("application/x-www-form-urlencoded") public void reindex(@FormParam("doc1") long docId, @FormParam("content") String content) throws ExceptionDescription copied from interface:DocumentServiceRe-indexes(or indexes from scratch) a document- Specified by:
reindexin interfaceDocumentService- Parameters:
docId- The document idcontent- The content to be used (if null the file is parsed)- Throws:
Exception- error in the server application
-
uploadResource
@POST @Path("/uploadResource") @Consumes("multipart/form-data") public void uploadResource(List<org.apache.cxf.jaxrs.ext.multipart.Attachment> attachments) throws ExceptionDescription copied from interface:DocumentServiceUploads a new resource attached to the given document. If the resource already exists it is overwritten.- Specified by:
uploadResourcein interfaceDocumentService- Throws:
Exception- error in the server application
-
restore
@PUT @Path("/restore") public void restore(@QueryParam("docId") long docId, @QueryParam("folderId") long folderId) throws ExceptionDescription copied from interface:DocumentServiceRestores a deleted document- Specified by:
restorein interfaceDocumentService- Parameters:
docId- The document idfolderId- Id of the folder in which the document must be restored- Throws:
Exception- error in the server application
-
saveNote
@POST @Path("/saveNote") public WSNote saveNote(@FormParam("docId") long docId, @FormParam("note") WSNote note) throws ExceptionDescription copied from interface:DocumentServiceAdds a new note for the given document- Specified by:
saveNotein interfaceDocumentService- Parameters:
docId- identifier of the documentnote- the note to add- Returns:
- the added note
- Throws:
Exception- error in the server application
-
sendEmail
@POST @Path("/sendEmail") @Consumes("application/x-www-form-urlencoded") public void sendEmail(@FormParam("docIds") Long[] docIds, @FormParam("recipients") String recipients, @FormParam("subject") String subject, @FormParam("message") String message) throws ExceptionDescription copied from interface:DocumentServiceSends a set of documents as mail attachments- Specified by:
sendEmailin interfaceDocumentService- Parameters:
docIds- Set of document identifiersrecipients- Set of recipients(comma separated)subject- The email subjectmessage- The email message body- Throws:
Exception- error in the server application
-
setPassword
@POST @Path("/setPassword") @Consumes("application/x-www-form-urlencoded") public void setPassword(@FormParam("docId") long docId, @FormParam("password") String password) throws ExceptionDescription copied from interface:DocumentServicePuts a password protection to the document- Specified by:
setPasswordin interfaceDocumentService- Parameters:
docId- identifier of the documentpassword- the new password- Throws:
Exception- error in the server application
-
unlock
@PUT @Path("/unlock") public void unlock(@QueryParam("docId") long docId) throws ExceptionDescription copied from interface:DocumentServiceUnlocks an existing document with the given identifier.- Specified by:
unlockin interfaceDocumentService- Parameters:
docId- identifier of the document- Throws:
Exception- error in the server application
-
unsetPassword
@POST @Path("/unsetPassword") @Consumes("application/x-www-form-urlencoded") public void unsetPassword(@FormParam("docId") long docId, @FormParam("currentPassword") String currentPassword) throws ExceptionDescription copied from interface:DocumentServiceRemoves the password protection from the document- Specified by:
unsetPasswordin interfaceDocumentService- Parameters:
docId- identifier of the documentcurrentPassword- the password- Throws:
Exception- error in the server application
-
unprotect
@POST @Path("/unprotect") @Consumes("application/x-www-form-urlencoded") public boolean unprotect(@FormParam("docId") long docId, @FormParam("password") String password) throws ExceptionDescription copied from interface:DocumentServiceUnprotects a document that is password protected. If the given password is right, the document remains unprotected for the duration of the session- Specified by:
unprotectin interfaceDocumentService- Parameters:
docId- identifier of the documentpassword- the password- Returns:
- was it uprotected?
- Throws:
Exception- error in the server application
-
-