Package com.logicaldoc.webservice.rest.client

Class RestDocumentClient

java.lang.Object

com.logicaldoc.webservice.rest.client.AbstractRestClient<DocumentService>

com.logicaldoc.webservice.rest.client.RestDocumentClient

public class RestDocumentClient
extends AbstractRestClient<DocumentService>

Constructor Summary

Constructors

Constructor	Description
RestDocumentClient(String endpoint, String apiKey)
RestDocumentClient(String endpoint, String apiKey, int timeout)

Method Summary

Modifier and Type	Method	Description
WSNote	addNote(long docId, String note)
void	checkin(long docId, String comment, Boolean release, File packageFile)
void	checkout(long docId)
WSDocument	create(WSDocument document, jakarta.activation.DataHandler dataHandler)
WSDocument	create(WSDocument document, File packageFile)
void	createPdf(long docId, String fileVersion)
void	createThumbnail(long docId, String fileVersion, String type)
void	delete(long docId)
void	deleteNote(long noteId)	Adds a new note for the given document
void	deleteVersion(long docId, String version)	Adds a new note for the given document
jakarta.activation.DataHandler	getContent(long docId)
WSDocument	getDocument(long docId)
List<WSNote>	getNotes(long docId)	Gets the notes for the given document
List<WSRating>	getRatings(long docId)	Gets all the ratings of the given document
jakarta.activation.DataHandler	getVersionContent(long docId, String version)
List<WSDocument>	list(long folderId)
List<WSDocument>	listDocuments(long folderId, String fileName)
List<WSDocument>	listPaginated(long folderId, String fileName, String sort, Integer page, Integer max)
WSRating	rateDocument(long docId, int vote)	Puts a new rating on the given document
void	update(WSDocument document)

Methods inherited from class java.lang.Object

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

Constructor Details

RestDocumentClient

public RestDocumentClient(String endpoint,
 String apiKey)

RestDocumentClient

public RestDocumentClient(String endpoint,
 String apiKey,
 int timeout)

Method Details

create

public WSDocument create(WSDocument document,
 File packageFile)
                  throws FileNotFoundException

Throws:

FileNotFoundException

create

public WSDocument create(WSDocument document,
 jakarta.activation.DataHandler dataHandler)

list

public List<WSDocument> list(long folderId)
                      throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

listPaginated

public List<WSDocument> listPaginated(long folderId,
 String fileName,
 String sort,
 Integer page,
 Integer max)
                               throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

listDocuments

public List<WSDocument> listDocuments(long folderId,
 String fileName)
                               throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getDocument

public WSDocument getDocument(long docId)
                       throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

delete

public void delete(long docId)
            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getContent

public jakarta.activation.DataHandler getContent(long docId)
                                          throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
IOException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

IOException

getVersionContent

public jakarta.activation.DataHandler getVersionContent(long docId,
 String version)
                                                 throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
IOException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

IOException

checkout

public void checkout(long docId)
              throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

update

public void update(WSDocument document)
            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

checkin

public void checkin(long docId,
 String comment,
 Boolean release,
 File packageFile)
             throws FileNotFoundException

Throws:

FileNotFoundException

addNote

public WSNote addNote(long docId,
 String note)
               throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

deleteNote

public void deleteNote(long noteId)
                throws AuthenticationException,
WebserviceException,
PersistenceException

Adds a new note for the given document

Parameters:

noteId - identifier of the note

Throws:

PersistenceException - Error in the data layer

WebserviceException - Error in the Webservice layer

AuthenticationException - Authentication issue

deleteVersion

public void deleteVersion(long docId,
 String version)
                   throws AuthenticationException,
WebserviceException,
PersistenceException

Adds a new note for the given document

Parameters:

docId - identifier of the document

version - document's version

Throws:

PersistenceException - Error in the data layer

WebserviceException - Error in the Webservice layer

AuthenticationException - Authentication issue

getNotes

public List<WSNote> getNotes(long docId)
                      throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Gets the notes for the given document

Parameters:

docId - identifier of the document

Returns:

list of ratings

Throws:

PersistenceException - Error in the data layer

WebserviceException - Error in the Webservice layer

AuthenticationException - Authentication issue

PermissionException - Not enough permissions

UnexistingResourceException - The specified document does not exist

rateDocument

public WSRating rateDocument(long docId,
 int vote)
                      throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Puts a new rating on the given document

Parameters:

docId - identifier of the document

vote - the vote

Returns:

the rating

Throws:

PersistenceException - Error in the data layer

WebserviceException - Error in the Webservice layer

AuthenticationException - Authentication issue

PermissionException - Not enough permissions

UnexistingResourceException - The specified document does not exist

getRatings

public List<WSRating> getRatings(long docId)
                          throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Gets all the ratings of the given document

Parameters:

docId - identifier of the document

Returns:

array of ratings

Throws:

PersistenceException - Error in the data layer

WebserviceException - Error in the Webservice layer

AuthenticationException - Authentication issue

PermissionException - Not enough permissions

UnexistingResourceException - The specified document does not exist

createPdf

public void createPdf(long docId,
 String fileVersion)
               throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
IOException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

IOException

createThumbnail

public void createThumbnail(long docId,
 String fileVersion,
 String type)
                     throws AuthenticationException,
WebserviceException,
PersistenceException,
IOException

Throws:

AuthenticationException

WebserviceException

PersistenceException

IOException