Package org.alfresco.repo.transfer

Interface TransferTransmitter

All Known Implementing Classes:

HttpClientTransmitterImpl

public interface TransferTransmitter

Author:

brian

Method Summary

Modifier and Type	Method	Description
void	abort(Transfer transfer)	Abort the transfer
Transfer	begin(TransferTarget target, java.lang.String fromRepositoryId, TransferVersion fromVersion)	Begin a transfer, the transfer object returned will be used by subsequent calls to the transfer service.
void	commit(Transfer transfer)
TransferProgress	getStatus(Transfer transfer)	Get the status of an in process transfer
void	getTransferReport(Transfer transfer, java.io.OutputStream results)	Get the destination side transfer report from the destination and write it to the specified output stream.
void	prepare(Transfer transfer)
void	sendContent(Transfer transfer, java.util.Set<org.alfresco.service.cmr.repository.ContentData> data)	Send the content of the specified urls
void	sendManifest(Transfer transfer, java.io.File manifest, java.io.OutputStream results)
void	verifyTarget(TransferTarget target)	Verify that the target is available

Method Detail

verifyTarget

void verifyTarget(TransferTarget target)
           throws TransferException

Verify that the target is available

Parameters:

target - TransferTarget

Throws:

TransferException

begin

Transfer begin(TransferTarget target,
               java.lang.String fromRepositoryId,
               TransferVersion fromVersion)
        throws TransferException

Begin a transfer, the transfer object returned will be used by subsequent calls to the transfer service.

Parameters:

target - definition of where to transfer to.

fromRepositoryId - the repositoryID of the sending system

fromVersion - the version of the repository sending

Returns:

the transfer object or null if the target cannot be locked.

Throws:

TransferException

sendManifest

void sendManifest(Transfer transfer,
                  java.io.File manifest,
                  java.io.OutputStream results)
           throws TransferException

Parameters:

manifest - the transfer manifest file

transfer - the transfer object returned by an earlier call to begin

results - - where to write the results, probably a temporary file the output steam should be open and will be closed before the method returns.

Throws:

TransferException

sendContent

void sendContent(Transfer transfer,
                 java.util.Set<org.alfresco.service.cmr.repository.ContentData> data)

Send the content of the specified urls

Parameters:

transfer - the transfer object returned by an earlier call to begin

data - the content to send

Throws:

TransferException

prepare

void prepare(Transfer transfer)
      throws TransferException

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

commit

void commit(Transfer transfer)
     throws TransferException

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

abort

void abort(Transfer transfer)
    throws TransferException

Abort the transfer

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

getStatus

TransferProgress getStatus(Transfer transfer)
                    throws TransferException

Get the status of an in process transfer

Throws:

TransferException

getTransferReport

void getTransferReport(Transfer transfer,
                       java.io.OutputStream results)

Get the destination side transfer report from the destination and write it to the specified output stream.

The result stream will be closed.

Parameters:

transfer - the transfer object returned by an earlier call to begin

results - - where to write the contents of the transfer report.