Package 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

Abstract base class for file transfer implementations that link or copy files.

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	Description
AbstractExecFileTransfer()

Method Summary

Modifier and Type	Method	Description
protected void	checkLocation(java.io.File location, 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 java.lang.ProcessBuilder	createProcessBuilder(java.io.File file, java.io.File location)	Deprecated. override exec(File, File) instead
protected void	exec(java.io.File file, java.io.File location)	If createProcessBuilder(java.io.File,java.io.File) returns non-null, executes a local command corresponding to the ProcessBuilder 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(OriginalFile root, OriginalFile ofile)	Build a path of the form "root.path/root.name/file.path/file.name".
java.lang.String	transfer(TransferState state)	Transfer files as specified by the exec(File, File) implementation.

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

cleanupUpload, createTransfer, deleteTransferredFiles, finish, isWindows, printLine, 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,
                                 ServerError

Transfer files as specified by the exec(File, File) implementation.

Throws:

java.io.IOException

ServerError

getLocalLocation

protected java.io.File getLocalLocation(OriginalFile root,
                                        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,
                             RawFileStorePrx rawFileStore)
                      throws 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:

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

If createProcessBuilder(java.io.File,java.io.File) returns non-null, executes a local command corresponding to the ProcessBuilder and fails on non-0 return codes. If the ProcessBuilder is null, this method does nothing by default. This method should be overridden by subclasses, see for example CopyFileTransfer.

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 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:

ServerError

createProcessBuilder

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

Deprecated.

override exec(File, File) instead

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