com.oneandone.iocunitejb.simulators.sftpclient

Class SftpConnector

java.lang.Object

com.oneandone.iocunitejb.simulators.sftpclient.SftpConnector

public class SftpConnector
extends Object

SftpConnector connects to an sftp-server.
Supports methods to upload, read and delete files on an sftp-server.
Each public method is synchronized but shall not be used in multiple threads

Author:

nkaiser

Field Summary

Fields

Modifier and Type	Field and Description
protected SftpConfiguration	sftpConfiguration

Constructor Summary

Constructors

Constructor and Description
SftpConnector()

Method Summary

Modifier and Type	Method and Description
protected void	connect() Open sftpConnection to a sftp-server.
void	deleteFile(String path, String fileName) Deletes a file from sftp-server.
void	deleteFiles(String path, List<String> fileNames) Deletes a file from sftp-server.
protected void	disconnect() Close existing sftpConnection.
void	downloadFile(Path source, Path destination) Downloads a file from the SFTP server to the local disc.
Boolean	fileExists(String path, String fileName) Check if file exists in path.
byte[]	getFileContent(String path, String fileName) Return the content of a Streamfile.
List<String>	getFileNamesFromPath(String path) Retrieves all file names.
List<String>	getFileNamesFromPath(String path, Pattern fileNamePattern) Retrieves all file names with file name pattern criteria
Map<String,Date>	getFileNamesFromPath(String path, Pattern fileNamePattern, Date onlyOlderThan) Returns all files in a folder on stfp-server.
Map<String,Date>	getFileNamesFromPathOlderThan(String path, Date onlyOlderThan) Retrieves all file names with date criteria.
int	getPriority()
void	init(SftpConfiguration sftpConfiguration) Initializer method.
protected void	innerUploadFile(byte[] fileContent, String path, String fileName)
boolean	isActive() Check the connector state based on current local time, whether it is currently deactivated by configuration
void	moveFile(String oldPath, String newPath, String fileName) Moves a file to another path on the SFTP server.
void	preDestroy() Automatic disconnect
void	renameFile(String path, String oldFilename, String newFileName) Moves a file to another path on the SFTP server.
void	uploadFile(byte[] fileContent, String fileName) Uploads a file to the sftp-server in default directory.
void	uploadFile(byte[] fileContent, String path, String fileName) Uploads a file to the sftp-server.

Methods inherited from class java.lang.Object

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

Field Detail

sftpConfiguration

protected SftpConfiguration sftpConfiguration

Constructor Detail

SftpConnector

public SftpConnector()

Method Detail

preDestroy

@PreDestroy
public void preDestroy()

Automatic disconnect

init

public void init(SftpConfiguration sftpConfiguration)

Initializer method.

Parameters:

sftpConfiguration - configuration values

uploadFile

public void uploadFile(byte[] fileContent,
                       String fileName)

Uploads a file to the sftp-server in default directory.

Parameters:

fileContent - content of the file (example: asd123qwefffxyc)

fileName - name of the file on the server (example: REQ1and1654300.CAS)

uploadFile

public void uploadFile(byte[] fileContent,
                       String path,
                       String fileName)

Uploads a file to the sftp-server.

Parameters:

fileContent - content of the file (example: asd123qwefffxyc)

path - relative target-path on the sftp-server (example: out/)

fileName - name of the file on the server (example: REQ1and1654300.CAS)

innerUploadFile

protected void innerUploadFile(byte[] fileContent,
                               String path,
                               String fileName)

deleteFile

public void deleteFile(String path,
                       String fileName)

Deletes a file from sftp-server.

Parameters:

path - relative target-path on the sftp-server (example: in/)

fileName - name of the file on the server (example: RSP1and16543000.CAS)

Throws:

RuntimeException

deleteFiles

public void deleteFiles(String path,
                        List<String> fileNames)

Deletes a file from sftp-server.

Parameters:

path - relative target-path on the sftp-server (example: in/)

fileNames - name of the file on the server (example: RSP1and16543000.CAS)

Throws:

RuntimeException

moveFile

public void moveFile(String oldPath,
                     String newPath,
                     String fileName)

Moves a file to another path on the SFTP server.

Parameters:

oldPath - the current path of the file

newPath - the destination path to move the file to

fileName - the file to move

renameFile

public void renameFile(String path,
                       String oldFilename,
                       String newFileName)

Moves a file to another path on the SFTP server.

Parameters:

path - the current path of the file

oldFilename - the old file name

newFileName - the new file name

getFileNamesFromPath

public List<String> getFileNamesFromPath(String path)

Retrieves all file names.

Parameters:

path - path to retrieve from

Returns:

list with file names

getFileNamesFromPathOlderThan

public Map<String,Date> getFileNamesFromPathOlderThan(String path,
                                                      Date onlyOlderThan)

Retrieves all file names with date criteria.

Parameters:

path - path to retrieve from

onlyOlderThan - date criteria

Returns:

list with file names

getFileNamesFromPath

public List<String> getFileNamesFromPath(String path,
                                         Pattern fileNamePattern)

Retrieves all file names with file name pattern criteria

Parameters:

path - path to retrieve from

fileNamePattern - file name pattern criteria

Returns:

list with file names

getFileNamesFromPath

public Map<String,Date> getFileNamesFromPath(String path,
                                             Pattern fileNamePattern,
                                             Date onlyOlderThan)

Returns all files in a folder on stfp-server.

Parameters:

path - relative target-path on the sftp-server (example: in/)

fileNamePattern - file name pattern criteria

onlyOlderThan - date criteria

Returns:

list of file-names and last modification date

Throws:

RuntimeException

fileExists

public Boolean fileExists(String path,
                          String fileName)
                   throws RuntimeException

Check if file exists in path.

Parameters:

path - relative target-path on the sftp-server (example: in/)

fileName - name of the file on the server (example: RSP1and16543000.CAS)

Returns:

true if file exists

Throws:

RuntimeException - if can not check existence

getFileContent

public byte[] getFileContent(String path,
                             String fileName)

Return the content of a Streamfile.

Parameters:

path - relative target-path on the sftp-server (example: in/)

fileName - name of the file on the server (example: RSP1and16543000.CAS)

Returns:

content of the file

Throws:

RuntimeException

downloadFile

public void downloadFile(Path source,
                         Path destination)

Downloads a file from the SFTP server to the local disc.

Parameters:

source - relative file path on the SFTP server

destination - file path on the local disc

isActive

public boolean isActive()

Check the connector state based on current local time, whether it is currently deactivated by configuration

Returns:

true if connector is currently active

getPriority

public int getPriority()

connect

protected void connect()

Open sftpConnection to a sftp-server.

Throws:

RuntimeException

disconnect

protected void disconnect()

Close existing sftpConnection.