ome.formats.importer.transfers

Class AbstractFileTransfer

java.lang.Object

ome.formats.importer.transfers.AbstractFileTransfer

All Implemented Interfaces:

FileTransfer

Direct Known Subclasses:

AbstractExecFileTransfer, UploadFileTransfer

public abstract class AbstractFileTransfer
extends java.lang.Object
implements FileTransfer

Base FileTransfer implementation primarily providing the start(TransferState) and finish(TransferState, long) methods. Also used as the factory for FileTransfer implementations via createTransfer(String).

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFileTransfer.Transfers Enum of well-known FileTransfer names.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractFileTransfer()

Method Summary

Modifier and Type	Method and Description
protected void	cleanupUpload(omero.api.RawFileStorePrx rawFileStore, java.io.FileInputStream stream) Utility method for closing resources.
static FileTransfer	createTransfer(java.lang.String arg) Factory method for instantiating FileTransfer objects from a string.
protected void	deleteTransferredFiles(int errors, java.util.List<java.lang.String> srcFiles) Method used by subclasses during FileTransfer.afterTransfer(int, List) if they would like to remove all the files transferred in the set.
protected java.lang.String	finish(TransferState state, long offset) Save the current state to disk and finish all timing and logging.
protected boolean	isWindows() Uses os.name to determine whether or not this JVM is running under Windows.
protected void	printLine()
protected omero.api.RawFileStorePrx	start(TransferState state) Minimal start method which logs the file, calls TransferState.start(), and loads the RawFileStorePrx which any implementation will need.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ome.formats.importer.transfers.FileTransfer

afterTransfer, transfer

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

AbstractFileTransfer

public AbstractFileTransfer()

Method Detail

createTransfer

public static FileTransfer createTransfer(java.lang.String arg)

Factory method for instantiating FileTransfer objects from a string. Supported values can be found in the AbstractFileTransfer.Transfers enum. Otherwise, a FQN for a class on the classpath should be passed in.

Parameters:

arg - a type of FileTransfer instance as named among AbstractFileTransfer.Transfers

Returns:

the new FileTransfer instance of the requested type

start

protected omero.api.RawFileStorePrx start(TransferState state)
                                   throws omero.ServerError

Minimal start method which logs the file, calls TransferState.start(), and loads the RawFileStorePrx which any implementation will need.

Parameters:

state - the transfer state

Returns:

a raw file store proxy for the upload

Throws:

omero.ServerError - if the uploader could not be obtained

finish

protected java.lang.String finish(TransferState state,
                                  long offset)
                           throws omero.ServerError

Save the current state to disk and finish all timing and logging.

Parameters:

state - non-null

offset - total length transferred.

Returns:

client-side digest string.

Throws:

omero.ServerError - if the upload could not be completed and checksummed

cleanupUpload

protected void cleanupUpload(omero.api.RawFileStorePrx rawFileStore,
                             java.io.FileInputStream stream)
                      throws omero.ServerError

Utility method for closing resources.

Parameters:

rawFileStore - possibly null

stream - possibly null

Throws:

omero.ServerError - presently not at all as errors are simply logged, but possibly in the future

isWindows

protected boolean isWindows()

Uses os.name to determine whether or not this JVM is running under Windows. This is mostly used for determining which executables to run.

printLine

protected void printLine()

deleteTransferredFiles

protected void deleteTransferredFiles(int errors,
                                      java.util.List<java.lang.String> srcFiles)
                               throws CleanupFailure

Method used by subclasses during FileTransfer.afterTransfer(int, List) if they would like to remove all the files transferred in the set.

Throws:

CleanupFailure