Package org.cyclos.security.contentmanagement

Class DocumentServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

org.cyclos.security.contentmanagement.DocumentServiceSecurity

All Implemented Interfaces:

DocumentService, CRUDService<DocumentDTO,DocumentData,DocumentDataParams>, CRUDWithConfirmationPasswordService<DocumentDTO,DocumentData,DocumentDataParams>, Service

@Security
public class DocumentServiceSecurity
extends CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>
implements DocumentService

Security layer for DocumentService

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
DocumentServiceSecurity()

Method Summary

Modifier and Type	Method	Description
boolean	canPerformOperation(Document entity, CRUDOperation operation)	Returns whether the logged user can perform the given operation over the given entity
protected void	checkCreateNew(DocumentDataParams params)	Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
boolean	doHasManageAccess(Document document)	Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(Document document)	Should be implemented in order to return whether the caller is allowed to view the given entity.
DocumentVO	getDocument(DocumentVO documentVO)	Used to get the view only object of the document
RawFileVO	getDocumentFile(DocumentVO documentVO)	Return the file vo for a given document
DocumentSearchData	getDocumentSearchData(UserLocatorVO locator)	Returns data used to search documents, either over the given user or general documents
protected DocumentServiceLocal	getImplementation()	Should be implemented in order to return the actual implementation of the service
ProcessDynamicDocumentData	getProcessDynamicDocumentData(DocumentVO documentVO, UserLocatorVO locator)	Returns data used to fill a dynamic document based on the given user locator data
boolean	isAccessible(SessionData sessionData, Document entity)	Must be implemented in order to determine whether the given entity is accessible for the given session data.
List<DocumentVO>	listUserDocuments(UserLocatorVO locator)	List all documents enabled for the given user
String	processDynamicDocument(ProcessDynamicDocumentDTO params)	Processes the given document using the given user and custom field values
SerializableInputStream	readContent(DocumentVO documentVO)	Reads the contents of the document
void	saveFile(DocumentVO documentVO, String contentType, String fileName, SerializableInputStream contents)	Saves the given document, returning the generated identifier
Long	saveWithFile(DocumentDTO document, String contentType, String fileName, SerializableInputStream contents)	Saves the given document and file
Page<DocumentVO>	search(DocumentQuery query)	List all documents filtered by category

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canViewData, checkManageAccess, checkOperation, checkSave, checkViewAccess, customizeData, find, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, hasManageAccess, hasViewAccess, load, onBeforeSave, remove, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveEntityCheck, save, saveWithConfirmationPassword

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Constructor Detail

DocumentServiceSecurity

public DocumentServiceSecurity()

Method Detail

canPerformOperation

public boolean canPerformOperation(Document entity,
                                   CRUDOperation operation)

Description copied from class: CRUDServiceSecurity

Returns whether the logged user can perform the given operation over the given entity

Overrides:

canPerformOperation in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

doHasManageAccess

public boolean doHasManageAccess(Document document)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation

Specified by:

doHasManageAccess in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

doHasViewAccess

public boolean doHasViewAccess(Document document)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to view the given entity.

Specified by:

doHasViewAccess in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

getDocument

public DocumentVO getDocument(DocumentVO documentVO)

Description copied from interface: DocumentService

Used to get the view only object of the document

Specified by:

getDocument in interface DocumentService

getDocumentFile

public RawFileVO getDocumentFile(DocumentVO documentVO)

Description copied from interface: DocumentService

Return the file vo for a given document

Specified by:

getDocumentFile in interface DocumentService

getDocumentSearchData

public DocumentSearchData getDocumentSearchData(UserLocatorVO locator)
                                         throws FrameworkException

Description copied from interface: DocumentService

Returns data used to search documents, either over the given user or general documents

Specified by:

getDocumentSearchData in interface DocumentService

Throws:

FrameworkException

getProcessDynamicDocumentData

public ProcessDynamicDocumentData getProcessDynamicDocumentData(DocumentVO documentVO,
                                                                UserLocatorVO locator)

Description copied from interface: DocumentService

Returns data used to fill a dynamic document based on the given user locator data

Specified by:

getProcessDynamicDocumentData in interface DocumentService

isAccessible

public boolean isAccessible(SessionData sessionData,
                            Document entity)

Description copied from class: CRUDServiceSecurity

Must be implemented in order to determine whether the given entity is accessible for the given session data. This method shouldn't check the same condition as CRUDServiceSecurity.hasViewAccess(BaseEntity). If the only condition for an entity is CRUDServiceSecurity.hasViewAccess(BaseEntity), this method should return false.

Specified by:

isAccessible in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

listUserDocuments

public List<DocumentVO> listUserDocuments(UserLocatorVO locator)

Description copied from interface: DocumentService

List all documents enabled for the given user

Specified by:

listUserDocuments in interface DocumentService

processDynamicDocument

public String processDynamicDocument(ProcessDynamicDocumentDTO params)
                              throws ValidationException

Description copied from interface: DocumentService

Processes the given document using the given user and custom field values

Specified by:

processDynamicDocument in interface DocumentService

Throws:

ValidationException

readContent

public SerializableInputStream readContent(DocumentVO documentVO)
                                    throws EntityNotFoundException

Description copied from interface: DocumentService

Reads the contents of the document

Specified by:

readContent in interface DocumentService

Throws:

EntityNotFoundException - When the image is not found

saveFile

public void saveFile(DocumentVO documentVO,
                     String contentType,
                     String fileName,
                     SerializableInputStream contents)

Description copied from interface: DocumentService

Saves the given document, returning the generated identifier

Specified by:

saveFile in interface DocumentService

saveWithFile

public Long saveWithFile(DocumentDTO document,
                         String contentType,
                         String fileName,
                         SerializableInputStream contents)

Description copied from interface: DocumentService

Saves the given document and file

Specified by:

saveWithFile in interface DocumentService

search

public Page<DocumentVO> search(DocumentQuery query)

Description copied from interface: DocumentService

List all documents filtered by category

Specified by:

search in interface DocumentService

checkCreateNew

protected void checkCreateNew(DocumentDataParams params)

Description copied from class: CRUDServiceSecurity

Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not

Specified by:

checkCreateNew in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>

getImplementation

protected DocumentServiceLocal getImplementation()

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return the actual implementation of the service

Specified by:

getImplementation in class CRUDServiceSecurity<DocumentDTO,Document,DocumentData,DocumentDataParams>