ome.formats.importer.transfers

Class TransferState

java.lang.Object

ome.formats.importer.transfers.TransferState

All Implemented Interfaces:

TimeEstimator

public class TransferState
extends Object
implements TimeEstimator

Non-thread-safe argument holder for FileTransfer implementations. A single instance will be created per invocation of FileTransfer.transfer(TransferState). Several instance methods are provided for common reporting actions (See usage in existing FileTransfer implementations.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
TransferState(File file, int index, int total, omero.grid.ImportProcessPrx proc, ImportLibrary library, TimeEstimator estimator, ChecksumProvider cp, byte[] buf) State of the current file transfer.

Method Summary

Modifier and Type	Method and Description
void	closeUploader() Call StatefulServiceInterfacePrx.close() on the cached uploader instance if non-null and null the instance.
byte[]	getBuffer() (Not thread safe) Get a moderately large buffer for use in reading/writing data.
String	getChecksum() Get the digest string for the local file.
ChecksumProvider	getChecksumProvider() Get the ChecksumProvider passed to the constructor.
File	getFile() Return the target file passed to the constructor.
long	getLength() Return the length of the target file.
omero.model.OriginalFile	getOriginalFile() Find original file as defined by the ID in the RawFileStorePrx regardless of group.
omero.model.OriginalFile	getRootFile() Find original file represented by the managed repository that import is taking place to.
omero.api.RawFileStorePrx	getUploader()
omero.api.RawFileStorePrx	getUploader(String mode) Return the RawFileStorePrx instance for this index setting the mode if not null.
long	getUploadTimeLeft() Return the estimated time left in milliseconds based on the calls to start and stop methods.
void	save() Calls RawFileStorePrx.save() and stores the resultant OriginalFile for future inspection along with the local checksum.
void	start() Starts the time counting.
void	stop() Stops the time counting and updates the internal time counter.
void	stop(long uploadedBytes) Stops the time counting and updates the internal updates the internal time counter and counter of total number of transmitted bytes.
void	uploadBytes(long offset) Raise the ImportEvent.FILE_UPLOAD_BYTES event to all observers.
void	uploadComplete(long offset) Raise the ImportEvent.FILE_UPLOAD_COMPLETE event to all observers.
void	uploadStarted() Raise the ImportEvent.FILE_UPLOAD_STARTED event to all observers.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferState

public TransferState(File file,
                     int index,
                     int total,
                     omero.grid.ImportProcessPrx proc,
                     ImportLibrary library,
                     TimeEstimator estimator,
                     ChecksumProvider cp,
                     byte[] buf)
              throws IOException,
                     omero.ServerError

State of the current file transfer.

Parameters:

file - Source file which is to be transferred.

index - Which of the total files to upload this is.

total - Total number of files to upload.

proc - ImportProcessPrx which is being imported to.

library - ImportLibrary to use for notifications.

estimator - a time-to-completion estimator.

cp - a checksum provider, for calculating file content checksums.

buf - optional buffer. Need not be used or updated.

Throws:

IOException - I/O exception

omero.ServerError - server error

Method Detail

save

public void save()
          throws omero.ServerError

Calls RawFileStorePrx.save() and stores the resultant OriginalFile for future inspection along with the local checksum. (The remote checksum is available from the OriginalFile.

Throws:

omero.ServerError - server error

getBuffer

public byte[] getBuffer()

(Not thread safe) Get a moderately large buffer for use in reading/writing data. To prevent the creation of many MB-sized byte arrays, this value can be re-used but requires external synchronization.

Returns:

the buffer

getChecksum

public String getChecksum()

Get the digest string for the local file. This will only be available, i.e. non-null, after save() has been called.

Returns:

the checksum

getChecksumProvider

public ChecksumProvider getChecksumProvider()

Get the ChecksumProvider passed to the constructor. Since the ChecksumProvider has a number of different usage styles, TransferState doesn't attempt to delegate but just returns the instance.

Returns:

the checksum provider used for calculating the checksum

getFile

public File getFile()

Return the target file passed to the constructor.

Returns:

the source file

getLength

public long getLength()

Return the length of the target file.

Returns:

the length of the source file

getOriginalFile

public omero.model.OriginalFile getOriginalFile()
                                         throws omero.ServerError

Find original file as defined by the ID in the RawFileStorePrx regardless of group.

Returns:

the original file from the upload process

Throws:

omero.ServerError - server error

getRootFile

public omero.model.OriginalFile getRootFile()
                                     throws omero.ServerError

Find original file represented by the managed repository that import is taking place to.

Returns:

the original file at the root of the repository targeted by the upload process

Throws:

omero.ServerError - server error

getUploader

public omero.api.RawFileStorePrx getUploader()
                                      throws omero.ServerError

Returns:

the RawFileStorePrx instance for this index

Throws:

omero.ServerError - server error

getUploader

public omero.api.RawFileStorePrx getUploader(String mode)
                                      throws omero.ServerError

Return the RawFileStorePrx instance for this index setting the mode if not null. Valid values include "r" and "rw". If a non-null uploader is available, it will be returned instead. Every instance which is returned from this method should eventually have StatefulServiceInterfacePrx.close() called on it. StatefulServiceInterfacePrx.close() can be used to facilitate this.

Parameters:

mode - the mode as understood by PublicRepositoryI.file(String, String, Ice.Current)

Returns:

the RawFileStorePrx instance

Throws:

omero.ServerError - server error

closeUploader

public void closeUploader()

Call StatefulServiceInterfacePrx.close() on the cached uploader instance if non-null and null the instance. If ObjectNotExistException is thrown, the service is assumed closed. All other exceptions will be printed at WARN.

uploadStarted

public void uploadStarted()

Raise the ImportEvent.FILE_UPLOAD_STARTED event to all observers.

uploadBytes

public void uploadBytes(long offset)

Raise the ImportEvent.FILE_UPLOAD_BYTES event to all observers.

Parameters:

offset - how many bytes are uploaded

uploadComplete

public void uploadComplete(long offset)

Raise the ImportEvent.FILE_UPLOAD_COMPLETE event to all observers.

Parameters:

offset - how many bytes are uploaded

start

public void start()

Description copied from interface: TimeEstimator

Starts the time counting.

Specified by:

start in interface TimeEstimator

stop

public void stop()

Description copied from interface: TimeEstimator

Stops the time counting and updates the internal time counter.

Specified by:

stop in interface TimeEstimator

stop

public void stop(long uploadedBytes)

Description copied from interface: TimeEstimator

Stops the time counting and updates the internal updates the internal time counter and counter of total number of transmitted bytes.

Specified by:

stop in interface TimeEstimator

Parameters:

uploadedBytes - Number of bytes uploaded in a single time frame that is being sampled.

getUploadTimeLeft

public long getUploadTimeLeft()

Description copied from interface: TimeEstimator

Return the estimated time left in milliseconds based on the calls to start and stop methods.

Specified by:

getUploadTimeLeft in interface TimeEstimator

Returns:

The estimated time remaining. The value 0 is returned if stop hasn't been called at least once before calling this method.