/*
* LinShare is an open source filesharing software, part of the LinPKI software
* suite, developed by Linagora.
*
* Copyright (C) 2015 LINAGORA
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version, provided you comply with the Additional Terms applicable for
* LinShare software by Linagora pursuant to Section 7 of the GNU Affero General
* Public License, subsections (b), (c), and (e), pursuant to which you must
* notably (i) retain the display of the “LinShare™” trademark/logo at the top
* of the interface window, the display of the “You are using the Open Source
* and free version of LinShare™, powered by Linagora © 2009–2015. Contribute to
* Linshare R&D by subscribing to an Enterprise offer!” infobox and in the
* e-mails sent with the Program, (ii) retain all hypertext links between
* LinShare and linshare.org, between linagora.com and Linagora, and (iii)
* refrain from infringing Linagora intellectual property rights over its
* trademarks and commercial brands. Other Additional Terms apply, see
* <http://www.linagora.com/licenses/> for more details.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License and
* its applicable Additional Terms for LinShare along with this program. If not,
* see <http://www.gnu.org/licenses/> for the GNU Affero General Public License
* version 3 and <http://www.linagora.com/licenses/> for the Additional Terms
* applicable to LinShare software.
*/
package org.linagora.linshare.core.service;
import java.io.File;
import java.io.InputStream;
import java.util.List;
import org.linagora.linshare.core.domain.entities.AbstractDomain;
import org.linagora.linshare.core.domain.entities.Account;
import org.linagora.linshare.core.domain.entities.DocumentEntry;
import org.linagora.linshare.core.domain.entities.SystemAccount;
import org.linagora.linshare.core.exception.BusinessException;
public interface DocumentEntryService {
public DocumentEntry create(Account actor, Account owner, File tempFile, String fileName, String comment, boolean forceAntivirusOff, boolean isFromCmis, String metadata) throws BusinessException;
public DocumentEntry create(Account actor, Account owner, File tempFile, String fileName, String comment, boolean isFromCmis, String metadata) throws BusinessException;
public DocumentEntry update(Account actor, Account owner, String docEntryUuid, File tempFile, String fileName) throws BusinessException ;
/**
* Document suppression due to user action.
* @param actor TODO
* @param owner
* @param documentUuid
* @return TODO
* @throws BusinessException
*/
public DocumentEntry delete(Account actor, Account owner, String documentUuid) throws BusinessException;
/**
* This method is designed inconsistent document, the document exists into the database only (no on the file system)
* @param actor
* @param documentEntry
* @throws BusinessException
*/
public void deleteInconsistentDocumentEntry(SystemAccount actor, DocumentEntry documentEntry) throws BusinessException;
/**
* This method is designed to delete expired documents (batches).
* @param actor
* @param documentEntry
* @throws BusinessException
*/
public void deleteExpiredDocumentEntry(SystemAccount actor, DocumentEntry documentEntry) throws BusinessException;
/**
* Get the thumbnail (InputStream) of the document
* @param actor TODO
* @param uuid the identifier of the document
* @return InputStream of the thumbnail
*/
public InputStream getDocumentThumbnailStream(Account actor, Account owner, String uuid) throws BusinessException;
public InputStream getDocumentStream(Account actor, Account owner, String uuid) throws BusinessException;
/**
* looking for a document entry using the uuid parameter.
* Owner and actor rights will be check. A {@link BusinessException}
* could be raise it the entry is not found or the actor is not allowed
* to access to it.
* @param actor
* @param owner
* @param uuid
* @return
* @throws BusinessException
*/
public DocumentEntry find(Account actor, Account owner, String uuid) throws BusinessException;
public List<DocumentEntry> findAll(Account actor, Account owner) throws BusinessException;
public List<DocumentEntry> findAllMySyncEntries(Account actor, Account owner) throws BusinessException;
public DocumentEntry findMoreRecentByName(Account actor, Account owner, String fileName) throws BusinessException;
public void renameDocumentEntry(Account actor, Account owner, String docEntryUuid, String newName) throws BusinessException ;
public boolean mimeTypeFilteringStatus(Account actor) throws BusinessException;
public DocumentEntry updateFileProperties(Account actor, Account owner, String uuid, String newName, String fileComment, String meta) throws BusinessException;
void updateFileProperties(Account actor, String docEntryUuid,
String newName, String fileComment, boolean cmisSync)
throws BusinessException;
long getRelatedEntriesCount(Account actor, Account owner, DocumentEntry documentEntry);
void deleteOrComputeExpiryDate(SystemAccount actor,
AbstractDomain domain, DocumentEntry documentEntry);
List<String> findAllExpiredEntries(Account actor, Account owner);
void checkDownloadPermission(Account actor, Account owner, String uuid);
}