org.alfresco.repo.transfer
Interface TransferTransmitter

All Known Implementing Classes:
HttpClientTransmitterImpl, UnitTestInProcessTransmitterImpl

public interface TransferTransmitter


Method Summary
 void abort(Transfer transfer)
          Abort the transfer
 Transfer begin(TransferTarget target)
          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 prepare(Transfer transfer)
           
 void sendContent(Transfer transfer, java.util.Set data)
          Send the content of the specified urls
 DeltaList sendManifest(Transfer transfer, java.io.File manifest)
           
 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 -
Throws:
TransferException

begin

Transfer begin(TransferTarget target)
               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.
Returns:
the transfer object or null if the target cannot be locked.
Throws:
TransferException

sendManifest

DeltaList sendManifest(Transfer transfer,
                       java.io.File manifest)
                       throws TransferException
Parameters:
manifest, - the transfer manifest file
transfer - the transfer object returned by an earlier call to begin
Returns:
the delta list.
Throws:
TransferException

sendContent

void sendContent(Transfer transfer,
                 java.util.Set 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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.