com.oneandone.iocunitejb.simulators.sftpclient.upload

Interface UploadFileHandler

All Known Implementing Classes:

NoTmpUploadFileHandler, TmpFileExtensionUploadFileHandler, TmpFilePrefixUploadFileHandler, UploadFileInTempDirectoryHandler

public interface UploadFileHandler

Handler to handle uploading Files in SftpConnector. There are different implementations like uploading in temporary directory or uploading in temporary files first.

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORK_FILE_DIRECTORY constant for workFileDirectory, needed by method getUploadFileName(String, String)

Method Summary

Modifier and Type	Method and Description
String	doExceptionHandling(com.jcraft.jsch.ChannelSftp channel, String uploadFileName, String targetFile, boolean isUploadSuccessful) do specialized ExceptionHandling depending on uploading strategy.
void	doRenameToTargetFile(com.jcraft.jsch.ChannelSftp channel, String uploadFileName, String targetFileName) rename uploadFileName to targetFileName, if uploadFile is a temporary file.
String	getUploadFileName(String path, String fileName) return the temporary or not temporary uploadFileName

Field Detail

WORK_FILE_DIRECTORY

static final String WORK_FILE_DIRECTORY

constant for workFileDirectory, needed by method getUploadFileName(String, String)

See Also:

Constant Field Values

Method Detail

getUploadFileName

String getUploadFileName(String path,
                         String fileName)

return the temporary or not temporary uploadFileName

Parameters:

path - Path

fileName - target FileName

Returns:

temporary or not temporary uploadFileName used in SftpConnector

doRenameToTargetFile

void doRenameToTargetFile(com.jcraft.jsch.ChannelSftp channel,
                          String uploadFileName,
                          String targetFileName)
                   throws com.jcraft.jsch.SftpException

rename uploadFileName to targetFileName, if uploadFile is a temporary file. If no temporary file is used, do nothing.

Parameters:

channel - ChannelSftp

uploadFileName - temporary fileName

targetFileName - final target File Name

Throws:

com.jcraft.jsch.SftpException - if renaming fails

doExceptionHandling

String doExceptionHandling(com.jcraft.jsch.ChannelSftp channel,
                           String uploadFileName,
                           String targetFile,
                           boolean isUploadSuccessful)

do specialized ExceptionHandling depending on uploading strategy.

Parameters:

channel - ChannelSftp

uploadFileName - (temporary) fileName

targetFile - target Filename

isUploadSuccessful - true if upLoad of temporary file was successful and only the renaming to final target file fails

Returns:

exception message depending on uploading strategy and isUploadSuccessful