SymlinkFileTransfer (omero-blitz 5.8.0 API)

java.lang.Object
- ome.formats.importer.transfers.AbstractFileTransfer
- - ome.formats.importer.transfers.AbstractExecFileTransfer
  - - ome.formats.importer.transfers.SymlinkFileTransfer

All Implemented Interfaces:

FileTransfer
```
public class SymlinkFileTransfer
extends AbstractExecFileTransfer
```
Local-only file transfer mechanism which makes use of soft-linking. This is only useful where the commands "ln -s source target" (Unix) or "mklink target source" (Windows) 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 Description

SymlinkFileTransfer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterTransfer(int errors, java.util.List<java.lang.String> srcFiles)`	No cleanup is needed for soft-linking.
`protected java.lang.ProcessBuilder`	`createProcessBuilder(java.io.File file, java.io.File location)`	Executes "ln -s file location" (Unix) or "mklink location file" (Windows) and fails on non-0 return codes.

Methods inherited from class ome.formats.importer.transfers.AbstractExecFileTransfer
checkLocation, checkTarget, exec, failLocationCheck, getLocalLocation, printLine, transfer

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

- Constructor Detail
  - SymlinkFileTransfer
```
public SymlinkFileTransfer()
```
- Method Detail
  - createProcessBuilder
```
protected java.lang.ProcessBuilder createProcessBuilder(java.io.File file,
                                                        java.io.File location)
```
    Executes "ln -s file location" (Unix) or "mklink location file" (Windows) and fails on non-0 return codes.
    
    Specified by:
    
    createProcessBuilder in class AbstractExecFileTransfer
    
    Parameters:
    
    file - File to be copied.
    
    location - Location to copy to.
    
    Returns:
    
    an instance ready for performing the transfer
    
    Throws:
    
    java.io.IOException
  - afterTransfer
```
public void afterTransfer(int errors,
                          java.util.List<java.lang.String> srcFiles)
```
    No cleanup is needed for soft-linking.