Package org.cyclos.impl.contentmanagement

Class DocumentServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

org.cyclos.impl.contentmanagement.DocumentServiceImpl

All Implemented Interfaces:

DocumentServiceLocal, CRUDServiceLocal<Document,DocumentDTO,DocumentData,DocumentDataParams>, DocumentService, CRUDService<DocumentDTO,DocumentData,DocumentDataParams>, CRUDWithConfirmationPasswordService<DocumentDTO,DocumentData,DocumentDataParams>, Service

@Service
public class DocumentServiceImpl
extends CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>
implements DocumentServiceLocal

Implementation for DocumentService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

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

Fields inherited from class org.cyclos.impl.AbstractServerComponent

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

Fields inherited from interface org.cyclos.impl.contentmanagement.DocumentServiceLocal

ATTR_DOCUMENT

Constructor Summary

Constructors

Constructor	Description
DocumentServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected DocumentData	getData(Document document)	Returns details data for the given entity
DocumentVO	getDocument(DocumentVO documentVO)	Used to get the view only object of the document
int	getDocumentCount(User user)	Returns the documents count for the given user
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
ProcessDynamicDocumentData	getProcessDynamicDocumentData(DocumentVO documentVO, UserLocatorVO locator)	Returns data used to fill a dynamic document based on the given user locator data
protected Pair<DBQuery<?>,String>	getUniqueInternalNameQuery(DocumentDTO dto)	We override this method because in the case of UserDocument the owner is the user instead of the category as specified in the entity with OwnerEntity
protected Pair<DBQuery<?>,String>	getUniqueNameQuery(DocumentDTO dto)	We override this method because in the case of UserDocument the owner is the user instead of the category as specified in the entity with OwnerEntity
boolean	hasDocuments(User user)	Return true if the member have at least one document to view
boolean	hasIndividualDocuments(User user)	Returns true if the user have at least one individual document to view
boolean	hasSharedDocuments(User user)	Returns true if the user have at least one shared document to view
List<DocumentVO>	listUserDocuments(UserLocatorVO locator)	List all documents enabled for the given user
Document	newEntity(DocumentDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onBeforeRemove(Document doc)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(Document entity, Document currentCopy)	May be overridden in order to perform custom logic before saving an entity.
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
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeAll(User user)	Remove all indivitual documents for the given user
protected Validator	resolveValidator(DocumentDTO dto)
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 params)	List all documents filtered by category
protected org.apache.commons.collections4.BidiMap<Class<? extends Document>,Class<? extends DocumentDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onAfterSave, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, 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

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Constructor Detail

DocumentServiceImpl

public DocumentServiceImpl()

Method Detail

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

getDocumentCount

public int getDocumentCount(User user)

Description copied from interface: DocumentServiceLocal

Returns the documents count for the given user

Specified by:

getDocumentCount in interface DocumentServiceLocal

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

hasDocuments

public boolean hasDocuments(User user)

Description copied from interface: DocumentServiceLocal

Return true if the member have at least one document to view

Specified by:

hasDocuments in interface DocumentServiceLocal

hasIndividualDocuments

public boolean hasIndividualDocuments(User user)
                               throws FrameworkException

Description copied from interface: DocumentServiceLocal

Returns true if the user have at least one individual document to view

Specified by:

hasIndividualDocuments in interface DocumentServiceLocal

Throws:

FrameworkException

hasSharedDocuments

public boolean hasSharedDocuments(User user)
                           throws FrameworkException

Description copied from interface: DocumentServiceLocal

Returns true if the user have at least one shared document to view

Specified by:

hasSharedDocuments in interface DocumentServiceLocal

Throws:

FrameworkException

listUserDocuments

public List<DocumentVO> listUserDocuments(UserLocatorVO locator)
                                   throws FrameworkException

Description copied from interface: DocumentService

List all documents enabled for the given user

Specified by:

listUserDocuments in interface DocumentService

Throws:

FrameworkException

newEntity

public Document newEntity(DocumentDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<Document,DocumentDTO,DocumentData,DocumentDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

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)

Description copied from interface: DocumentService

Reads the contents of the document

Specified by:

readContent in interface DocumentService

removeAll

public void removeAll(User user)

Description copied from interface: DocumentServiceLocal

Remove all indivitual documents for the given user

Specified by:

removeAll in interface DocumentServiceLocal

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 params)

Description copied from interface: DocumentService

List all documents filtered by category

Specified by:

search in interface DocumentService

getData

protected DocumentData getData(Document document)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

getUniqueInternalNameQuery

protected Pair<DBQuery<?>,String> getUniqueInternalNameQuery(DocumentDTO dto)

We override this method because in the case of UserDocument the owner is the user instead of the category as specified in the entity with OwnerEntity

Overrides:

getUniqueInternalNameQuery in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

getUniqueNameQuery

protected Pair<DBQuery<?>,String> getUniqueNameQuery(DocumentDTO dto)

We override this method because in the case of UserDocument the owner is the user instead of the category as specified in the entity with OwnerEntity

Overrides:

getUniqueNameQuery in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

onBeforeRemove

protected void onBeforeRemove(Document doc)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before removing an entity

Overrides:

onBeforeRemove in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

onBeforeSave

protected Object onBeforeSave(Document entity,
                              Document currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(DocumentDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends Document>,Class<? extends DocumentDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<Document,QDocument,DocumentDTO,DocumentData,DocumentDataParams>