org.alfresco.repo.transfer.fsr

Class FileTransferReceiver

java.lang.Object

org.alfresco.repo.transfer.fsr.FileTransferReceiver

All Implemented Interfaces:

TransferReceiver

public class FileTransferReceiver
extends Object
implements TransferReceiver

Constructor Summary

Constructors

Constructor and Description
FileTransferReceiver()

Method Summary

Modifier and Type	Method and Description
void	cancel(String transferId) Abort
org.alfresco.repo.transfer.fsr.FileTransferReceiver.Lock	checkLock(String transferId)
void	commit(String transferId) Commit
void	commitAsync(String transferId) Commit asynchronously
void	end(String transferId) Asks the receiver to end (and clean up) the specified transfer
void	generateRequsite(String transferId, OutputStream requsiteStream) Write the requsite (the bits required to support the Manifest) to the output stream.
Map<String,File>	getContents()
DbHelper	getDbHelper()
String	getDefaultReceivingroot()
JobLockService	getJobLockService()
long	getLockRefreshTime()
int	getLockRetryCount()
long	getLockRetryWait()
long	getLockTimeOut()
ManifestProcessorFactory	getManifestProcessorFactory()
List<FSRRunnable>	getPostCommit()
TransferProgressMonitor	getProgressMonitor()
String	getRootStagingDirectory()
protected File	getSnapshotFile(String transferId)
File	getStagingFolder(String transferId)
TransferProgress	getStatus(String transferId)
org.alfresco.service.cmr.repository.NodeRef	getTempFolder(String transferId)
InputStream	getTransferReport(String transferId) get the transfer report for the specified transfer
String	getTransferRootNode()
TransferVersion	getVersion() Get the version that we are transfering to.
boolean	isContentNewOrModified(String nodeRef, String contentUrl)
void	prepare(String transferId) Prepare
void	saveContent(String transferId, String contentFileId, InputStream contentStream) Save a content item
void	saveSnapshot(String transferId, InputStream openStream) Store the specified snapshot file into the transfer staging area.
void	setDefaultReceivingroot(String defaultReceivingroot)
void	setDescriptorDAO(DescriptorDAO descriptorDAO)
void	setFileTransferInfoDAO(FileTransferInfoDAO fileTransferInfoDAO)
void	setJobLockService(JobLockService jobLockService)
void	setLockRefreshTime(long lockRefreshTime)
void	setLockRetryCount(int lockRetryCount)
void	setLockRetryWait(long lockRetryWait)
void	setLockTimeOut(long lockTimeOut)
void	setManifestProcessorFactory(ManifestProcessorFactory manifestProcessorFactory)
void	setPostCommit(List<FSRRunnable> postCommit)
void	setProgressMonitor(TransferProgressMonitor progressMonitor)
void	setRootStagingDirectory(String rootStagingDirectory)
void	setTransactionService(TransactionService transactionService)
void	setTransferRootNode(String rootFileSystem) set the root node for the file system receiver
String	start(String fromRepositoryId, boolean transferToSelf, TransferVersion fromVersion) Asks the receiver to setup a new transfer.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTransferReceiver

public FileTransferReceiver()

Method Detail

cancel

public void cancel(String transferId)
            throws TransferException

Description copied from interface: TransferReceiver

Abort

Specified by:

cancel in interface TransferReceiver

Parameters:

transferId - String

Throws:

TransferException

commit

public void commit(String transferId)
            throws TransferException

Description copied from interface: TransferReceiver

Commit

Specified by:

commit in interface TransferReceiver

Parameters:

transferId - String

Throws:

TransferException

commitAsync

public void commitAsync(String transferId)
                 throws TransferException

Description copied from interface: TransferReceiver

Commit asynchronously

Specified by:

commitAsync in interface TransferReceiver

Parameters:

transferId - String

Throws:

TransferException

end

public void end(String transferId)

Description copied from interface: TransferReceiver

Asks the receiver to end (and clean up) the specified transfer

Specified by:

end in interface TransferReceiver

Parameters:

transferId - The transfer to end

generateRequsite

public void generateRequsite(String transferId,
                             OutputStream requsiteStream)
                      throws TransferException

Description copied from interface: TransferReceiver

Write the requsite (the bits required to support the Manifest) to the output stream.

Specified by:

generateRequsite in interface TransferReceiver

requsiteStream - an open stream to receive the requisite

Throws:

TransferException

getProgressMonitor

public TransferProgressMonitor getProgressMonitor()

Specified by:

getProgressMonitor in interface TransferReceiver

Returns:

TransferProgressMonitor

getStagingFolder

public File getStagingFolder(String transferId)

Specified by:

getStagingFolder in interface TransferReceiver

Parameters:

transferId - String

Returns:

File

getStatus

public TransferProgress getStatus(String transferId)
                           throws TransferException

Specified by:

getStatus in interface TransferReceiver

Parameters:

transferId - String

Returns:

the trabsfer progress

Throws:

TransferException

getTempFolder

public org.alfresco.service.cmr.repository.NodeRef getTempFolder(String transferId)

Specified by:

getTempFolder in interface TransferReceiver

Parameters:

transferId - String

Returns:

NodeRef

getTransferReport

public InputStream getTransferReport(String transferId)

Description copied from interface: TransferReceiver

get the transfer report for the specified transfer

Specified by:

getTransferReport in interface TransferReceiver

Parameters:

transferId - String

getVersion

public TransferVersion getVersion()

Description copied from interface: TransferReceiver

Get the version that we are transfering to.

Specified by:

getVersion in interface TransferReceiver

prepare

public void prepare(String transferId)
             throws TransferException

Description copied from interface: TransferReceiver

Prepare

Specified by:

prepare in interface TransferReceiver

Parameters:

transferId - String

Throws:

TransferException

saveContent

public void saveContent(String transferId,
                        String contentFileId,
                        InputStream contentStream)
                 throws TransferException

Description copied from interface: TransferReceiver

Save a content item

Specified by:

saveContent in interface TransferReceiver

Parameters:

transferId - String

contentFileId - String

contentStream - InputStream

Throws:

TransferException

checkLock

public org.alfresco.repo.transfer.fsr.FileTransferReceiver.Lock checkLock(String transferId)
                                                                   throws TransferException

Throws:

TransferException

saveSnapshot

public void saveSnapshot(String transferId,
                         InputStream openStream)
                  throws TransferException

Description copied from interface: TransferReceiver

Store the specified snapshot file into the transfer staging area. The specified transfer must currently be the holder of the transfer lock, otherwise an exception is thrown. This operation does not close the supplied stream, so the caller must do it as appropriate. The caller should assume that the supplied stream has been fully read when this operation returns.

Specified by:

saveSnapshot in interface TransferReceiver

Parameters:

transferId - The identifier of the transfer with which this snapshot is associated

openStream - The open stream that holds the snapshot file.

Throws:

TransferException - If an error occurs while saving the snapshot file.

start

public String start(String fromRepositoryId,
                    boolean transferToSelf,
                    TransferVersion fromVersion)

Description copied from interface: TransferReceiver

Asks the receiver to setup a new transfer.

Specified by:

start in interface TransferReceiver

Parameters:

fromRepositoryId - the repositoryId of the sending system

transferToSelf - are transfers to the same repository allowed?

fromVersion - the version sending

Returns:

The identifier of the new transfer

setJobLockService

public void setJobLockService(JobLockService jobLockService)

getJobLockService

public JobLockService getJobLockService()

setLockRefreshTime

public void setLockRefreshTime(long lockRefreshTime)

getLockRefreshTime

public long getLockRefreshTime()

isContentNewOrModified

public boolean isContentNewOrModified(String nodeRef,
                                      String contentUrl)

getSnapshotFile

protected File getSnapshotFile(String transferId)

getLockRetryWait

public long getLockRetryWait()

setLockRetryWait

public void setLockRetryWait(long lockRetryWait)

getLockRetryCount

public int getLockRetryCount()

setLockRetryCount

public void setLockRetryCount(int lockRetryCount)

getLockTimeOut

public long getLockTimeOut()

setLockTimeOut

public void setLockTimeOut(long lockTimeOut)

setTransactionService

public void setTransactionService(TransactionService transactionService)

getRootStagingDirectory

public String getRootStagingDirectory()

setRootStagingDirectory

public void setRootStagingDirectory(String rootStagingDirectory)

getManifestProcessorFactory

public ManifestProcessorFactory getManifestProcessorFactory()

setManifestProcessorFactory

public void setManifestProcessorFactory(ManifestProcessorFactory manifestProcessorFactory)

setProgressMonitor

public void setProgressMonitor(TransferProgressMonitor progressMonitor)

getDefaultReceivingroot

public String getDefaultReceivingroot()

setDefaultReceivingroot

public void setDefaultReceivingroot(String defaultReceivingroot)

getContents

public Map<String,File> getContents()

setTransferRootNode

public void setTransferRootNode(String rootFileSystem)

Description copied from interface: TransferReceiver

set the root node for the file system receiver

Specified by:

setTransferRootNode in interface TransferReceiver

Parameters:

rootFileSystem - String

getTransferRootNode

public String getTransferRootNode()

setFileTransferInfoDAO

public void setFileTransferInfoDAO(FileTransferInfoDAO fileTransferInfoDAO)

setDescriptorDAO

public void setDescriptorDAO(DescriptorDAO descriptorDAO)

getDbHelper

public DbHelper getDbHelper()

setPostCommit

public void setPostCommit(List<FSRRunnable> postCommit)

getPostCommit

public List<FSRRunnable> getPostCommit()