mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
e0372702d3
implemented with unit test. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21836 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
94 lines
2.8 KiB
Java
94 lines
2.8 KiB
Java
/*
|
|
* Copyright (C) 2009-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package org.alfresco.repo.transfer;
|
|
|
|
import java.io.InputStream;
|
|
|
|
import org.alfresco.service.cmr.transfer.TransferException;
|
|
import org.alfresco.service.cmr.transfer.TransferProgress;
|
|
|
|
/**
|
|
* @author brian
|
|
*
|
|
* The transfer progress monitor monitors each transfer
|
|
* <p>
|
|
* It contains a status, current position, end position, and a log.
|
|
* It can also store an exception.
|
|
*
|
|
*/
|
|
public interface TransferProgressMonitor
|
|
{
|
|
/**
|
|
* log a message
|
|
* @param transferId
|
|
* @param obj
|
|
* @throws TransferException
|
|
*/
|
|
void log(String transferId, Object obj) throws TransferException;
|
|
/**
|
|
* log a message and an exception
|
|
* @param transferId
|
|
* @param obj
|
|
* @param ex
|
|
* @throws TransferException
|
|
*/
|
|
void log(String transferId, Object obj, Throwable ex) throws TransferException;
|
|
|
|
/**
|
|
* update the progress of the specified transfer
|
|
* @param transferId
|
|
* @param currPos
|
|
* @throws TransferException
|
|
*/
|
|
void updateProgress(String transferId, int currPos) throws TransferException;
|
|
|
|
/**
|
|
* update the progress of the specified transfer and possibly change the end position.
|
|
* @param transferId
|
|
* @param currPos
|
|
* @param endPos
|
|
* @throws TransferException
|
|
*/
|
|
void updateProgress(String transferId, int currPos, int endPos) throws TransferException;
|
|
|
|
/**
|
|
* update the startus of the transfer
|
|
* @param transferId
|
|
* @param status
|
|
* @throws TransferException
|
|
*/
|
|
void updateStatus(String transferId, TransferProgress.Status status) throws TransferException;
|
|
|
|
/**
|
|
* Read the progress of the
|
|
* @param transferId
|
|
* @return the progress of the transfer
|
|
* @throws TransferException
|
|
*/
|
|
TransferProgress getProgress(String transferId) throws TransferException;
|
|
|
|
/**
|
|
* After the transfer has completed this method reads the log.
|
|
* @param transferId
|
|
* @return the log
|
|
*/
|
|
InputStream getLogInputStream(String transferId) throws TransferException;
|
|
}
|