fr.ifremer.coselmar.services.v1

Class DocumentsWebService

java.lang.Object

org.debux.webmotion.server.WebMotionController

fr.ifremer.coselmar.services.CoselmarWebServiceSupport

fr.ifremer.coselmar.services.v1.DocumentsWebService

All Implemented Interfaces:

CoselmarService

public class DocumentsWebService
extends CoselmarWebServiceSupport

Author:

ymartel

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DOCUMENT_CREATE_ALLOWED_USER_ROLES
static List<String>	DOCUMENT_SUPER_USER_ROLES Kind of admin role
static List<String>	DOCUMENT_VIEW_ALLOWED_USER_ROLES

Fields inherited from class org.debux.webmotion.server.WebMotionController

contextable

Constructor Summary

Constructors

Constructor and Description
DocumentsWebService()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentBean	addDocument(DocumentBean document, org.debux.webmotion.server.call.UploadFile uploadFile)
void	addDocumentFile(String documentId, org.debux.webmotion.server.call.UploadFile uploadFile)
protected void	deleteAttachedFile(Document document) Delete physically Document File, and update Document entity setting filePath and fileName to null and withFile boolean to false
void	deleteDocument(String documentId)
DocumentBean	getDocument(String documentId)
org.debux.webmotion.server.render.Render	getDocumentFile(String documentId)
protected String	getDocumentFullId(String documentId)
List<DocumentBean>	getDocuments(List<String> searchKeywords)
protected List<String>	getDocumentsFullId(List<String> documentShortIds)
List<String>	getKeywords()
List<String>	getTypes()
protected String	getUserDocumentPath(CoselmarUser user)
protected boolean	isAllowedToAccessDocument(CoselmarUser user, Document document) Check if an user can access to a document metadata, according to its privacy settings and the user grant.
protected org.apache.commons.lang3.tuple.Pair<String,String>	managerDocumentFile(org.debux.webmotion.server.call.UploadFile uploadFile, CoselmarUser owner) When a Document is sent, it could have a File part : this manage the upload file.
protected Set<CoselmarUser>	retrieveUsers(Collection<UserBean> userBeans)
void	saveDocument(DocumentBean document)

Methods inherited from class fr.ifremer.coselmar.services.CoselmarWebServiceSupport

checkAuthentication, checkUserAuthentication, commit, getCleanMail, getCoselmarServicesConfig, getCoselmarUserDao, getCoselmarUserGroupDao, getDocumentDao, getDocumentsService, getFullIdFromShort, getFullUserIdFromShort, getLocale, getNow, getPersistenceContext, getQuestionDao, getServicesContext, getShortIdFromFull, newService, rollback, setServicesContext

Methods inherited from class org.debux.webmotion.server.WebMotionController

getContext, renderAction, renderAtom, renderContent, renderContent, renderDownload, renderDownload, renderError, renderError, renderFailure, renderForward, renderForward, renderJSON, renderJSONP, renderLastPage, renderRedirect, renderRSS, renderStatus, renderStream, renderStream, renderStringTemplate, renderSuccess, renderTemplate, renderURL, renderView, renderXML, setContextable, toMap

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_CREATE_ALLOWED_USER_ROLES

public static final List<String> DOCUMENT_CREATE_ALLOWED_USER_ROLES

DOCUMENT_SUPER_USER_ROLES

public static final List<String> DOCUMENT_SUPER_USER_ROLES

Kind of admin role

DOCUMENT_VIEW_ALLOWED_USER_ROLES

public static final List<String> DOCUMENT_VIEW_ALLOWED_USER_ROLES

Constructor Detail

DocumentsWebService

public DocumentsWebService()

Method Detail

getDocument

public DocumentBean getDocument(String documentId)
                         throws InvalidCredentialException,
                                UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getDocuments

public List<DocumentBean> getDocuments(List<String> searchKeywords)
                                throws InvalidCredentialException

Throws:

InvalidCredentialException

addDocument

public DocumentBean addDocument(DocumentBean document,
                       org.debux.webmotion.server.call.UploadFile uploadFile)
                         throws InvalidCredentialException,
                                UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

addDocumentFile

public void addDocumentFile(String documentId,
                   org.debux.webmotion.server.call.UploadFile uploadFile)
                     throws InvalidCredentialException,
                            UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getDocumentFile

public org.debux.webmotion.server.render.Render getDocumentFile(String documentId)
                                                         throws NoResultException

Throws:

NoResultException

saveDocument

public void saveDocument(DocumentBean document)
                  throws InvalidCredentialException,
                         UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

deleteDocument

public void deleteDocument(String documentId)
                    throws InvalidCredentialException,
                           UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getKeywords

public List<String> getKeywords()
                         throws InvalidCredentialException,
                                UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getTypes

public List<String> getTypes()
                      throws InvalidCredentialException,
                             UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

managerDocumentFile

protected org.apache.commons.lang3.tuple.Pair<String,String> managerDocumentFile(org.debux.webmotion.server.call.UploadFile uploadFile,
                                                                     CoselmarUser owner)

When a Document is sent, it could have a File part : this manage the upload file. The file is stored in the user specific directory, and the contentType of document is returned, cause need in Document Metadata.

Returns:

the upload file Metadata

getUserDocumentPath

protected String getUserDocumentPath(CoselmarUser user)

isAllowedToAccessDocument

protected boolean isAllowedToAccessDocument(CoselmarUser user,
                                Document document)

Check if an user can access to a document metadata, according to its privacy settings and the user grant.

Parameters:

user - : Current User, containing CoselmarUserRole as String

document - : the document user trying to access.

Returns:

true is user can access, false else.

getDocumentFullId

protected String getDocumentFullId(String documentId)

getDocumentsFullId

protected List<String> getDocumentsFullId(List<String> documentShortIds)

deleteAttachedFile

protected void deleteAttachedFile(Document document)

Delete physically Document File, and update Document entity setting filePath and fileName to null and withFile boolean to false

retrieveUsers

protected Set<CoselmarUser> retrieveUsers(Collection<UserBean> userBeans)