ome.formats.importer.transfers

Class AbstractExecFileTransfer

java.lang.Object

ome.formats.importer.transfers.AbstractFileTransfer

ome.formats.importer.transfers.AbstractExecFileTransfer

All Implemented Interfaces:

FileTransfer

Direct Known Subclasses:

CopyFileTransfer, HardlinkFileTransfer, SymlinkFileTransfer

public abstract class AbstractExecFileTransfer
extends AbstractFileTransfer

Local-only file transfer mechanism which makes use of soft-linking. This is only useful where the command "ln -s source target" will work.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class ome.formats.importer.transfers.AbstractFileTransfer

AbstractFileTransfer.Transfers

Field Summary

Fields inherited from class ome.formats.importer.transfers.AbstractFileTransfer

log

Constructor Summary

Constructors

Constructor and Description
AbstractExecFileTransfer()

Method Summary

Modifier and Type	Method and Description
protected void	checkLocation(java.io.File location, omero.api.RawFileStorePrx rawFileStore) Check that the target location: 1) doesn't exist and 2) is properly written to by the server.
protected void	checkTarget(java.io.File location, TransferState state) Check that the server can properly read the copied file.
protected abstract java.lang.ProcessBuilder	createProcessBuilder(java.io.File file, java.io.File location) Creates a ProcessBuilder instance ready to have ProcessBuilder.start() called on it.
protected void	exec(java.io.File file, java.io.File location) Executes a local command and fails on non-0 return codes.
protected java.lang.RuntimeException	failLocationCheck(java.io.File location, java.lang.String msg)
protected java.io.File	getLocalLocation(omero.model.OriginalFile root, omero.model.OriginalFile ofile) Build a path of the form "root.path/root.name/file.path/file.name".
protected void	printLine()
java.lang.String	transfer(TransferState state) "Transfer" files by soft-linking them into place.

Methods inherited from class ome.formats.importer.transfers.AbstractFileTransfer

cleanupUpload, createTransfer, deleteTransferredFiles, finish, isWindows, start

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

Constructor Detail

AbstractExecFileTransfer

public AbstractExecFileTransfer()

Method Detail

transfer

public java.lang.String transfer(TransferState state)
                          throws java.io.IOException,
                                 omero.ServerError

"Transfer" files by soft-linking them into place. This method is likely re-usable for other general "linking" strategies by overriding createProcessBuilder(File, File) and the other protected methods here.

Throws:

java.io.IOException

omero.ServerError

getLocalLocation

protected java.io.File getLocalLocation(omero.model.OriginalFile root,
                                        omero.model.OriginalFile ofile)

Build a path of the form "root.path/root.name/file.path/file.name".

Parameters:

root - the root directory

ofile - a path relative to the root

Returns:

the assembled path with separators suitable for the local filesystem

checkLocation

protected void checkLocation(java.io.File location,
                             omero.api.RawFileStorePrx rawFileStore)
                      throws omero.ServerError,
                             java.io.IOException

Check that the target location: 1) doesn't exist and 2) is properly written to by the server. If either condition fails, no linking takes place.

Parameters:

location - the source file

rawFileStore - the target on the server

Throws:

omero.ServerError - if the raw file store could not be used

java.io.IOException - for problems with the source file

failLocationCheck

protected java.lang.RuntimeException failLocationCheck(java.io.File location,
                                                       java.lang.String msg)

exec

protected void exec(java.io.File file,
                    java.io.File location)
             throws java.io.IOException

Executes a local command and fails on non-0 return codes.

Parameters:

file - the source file

location - the target on the server

Throws:

java.io.IOException - for problems with the source file

checkTarget

protected void checkTarget(java.io.File location,
                           TransferState state)
                    throws omero.ServerError

Check that the server can properly read the copied file. Like checkLocation(File, RawFileStorePrx) but after the invocation of exec(File, File), there is some chance, likely due to file permissions, that the server will not be able to read the transfered file. If so, raise an exception and leave the user to cleanup and modifications.

Throws:

omero.ServerError

createProcessBuilder

protected abstract java.lang.ProcessBuilder createProcessBuilder(java.io.File file,
                                                                 java.io.File location)

Creates a ProcessBuilder instance ready to have ProcessBuilder.start() called on it. The only critical piece of information should be the return code.

Parameters:

file - File to be copied.

location - Location to copy to.

Returns:

an instance ready for performing the transfer

printLine

protected void printLine()

Overrides:

printLine in class AbstractFileTransfer