Class JSftpModule

java.lang.Object

ecmwf.common.ectrans.TransferModule

ecmwf.common.ectrans.module.JSftpModule

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

SftpModule

public class JSftpModule
extends TransferModule

The Class JSftpModule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JSftpModule.JSftpLogger	The Class JSftpLogger.
static final class	JSftpModule.ProgressMonitor	The Class ProgressMonitor.

Constructor Summary

Constructors

Constructor	Description
JSftpModule()

Method Summary

Modifier and Type	Method	Description
void	check(long sent, String checksum)	Check if the last put was successful comparing the number of bytes sent and the checksum provided to the one calculated.
void	close()	Close.
void	connect(String location, ECtransSetup setup)	Connect.
void	del(String name)	Delete by name.
int	exec(String command)	Exec.
boolean	get(OutputStream out, String name, long posn)	Gets the content of the file given by name written to the provided output stream, starting at posn.
InputStream	get(String name, long posn)	Gets the input stream to read the file given by name starting at posn.
int	getPort(ECtransSetup setup)	Gets the port from the setup.
String	getStatus()	Gets the current status of the transfer module.
String[]	listAsStringArray(String directory, String pattern)	List as a string array.
void	mkdir(String dir)	Make directory by name.
void	mkdirs(String dir)	Mkdirs.
void	move(String source, String target)	Move source to target.
void	preGet(String name, long posn)	Pre-get.
String	prePut(String name, String tmpName, long posn)	Pre-put.
boolean	put(InputStream in, String name, long posn, long size)	Write the content of the file given by its name, starting at position posn and writing to the provided input stream.
OutputStream	put(String name, long posn, long size)	Provide an output stream to write the content of the file given by its name starting at position posn.
void	rmdir(String dir)	Remove directory by name.
long	size(String name)	Give the size of the file given by its name.
void	updateSocketStatistics()	Force an update of the statistics from the underlying socket.

Methods inherited from class ecmwf.common.ectrans.TransferModule

containsAttribute, copy, delegateChecksum, getAttribute, getAttribute, getAvailable, getClearPassword, getClosedOnError, getCookie, getDebug, getECtransDestination, getECtransModule, getECUser, getMSUser, getRemoteProvider, list, listAsByteArray, setAttribute, setAttribute, setAvailable, setClosedOnError, setDebug, setInputFilter, setInputMd5, setInputSize, setOutputFilter

Methods inherited from class java.lang.Object

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

Constructor Details

JSftpModule

public JSftpModule()

Method Details

getStatus

public String getStatus()

Gets the current status of the transfer module. Gets the status.

Overrides:

getStatus in class TransferModule

Returns:

the status

getPort

public int getPort(ECtransSetup setup)

Gets the port from the setup. Gets the port.

Overrides:

getPort in class TransferModule

Parameters:

setup - the setup

Returns:

the port

updateSocketStatistics

public void updateSocketStatistics()
                            throws IOException

Force an update of the statistics from the underlying socket. Update socket statistics.

Overrides:

updateSocketStatistics in class TransferModule

Throws:

IOException - Signals that an I/O exception has occurred.

connect

public void connect(String location,
 ECtransSetup setup)
             throws IOException

Connect. Connect.

Specified by:

connect in class TransferModule

Parameters:

location - the location

setup - the setup

Throws:

IOException

del

public void del(String name)
         throws IOException

Delete by name. Del.

Specified by:

del in class TransferModule

Parameters:

name - the name

Throws:

IOException - Signals that an I/O exception has occurred.

mkdirs

public void mkdirs(String dir)
            throws IOException

Mkdirs.

Parameters:

dir - the dir

Throws:

IOException - Signals that an I/O exception has occurred.

mkdir

public void mkdir(String dir)
           throws IOException

Make directory by name. Mkdir.

Overrides:

mkdir in class TransferModule

Parameters:

dir - the dir

Throws:

IOException - Signals that an I/O exception has occurred.

rmdir

public void rmdir(String dir)
           throws IOException

Remove directory by name. Rmdir.

Overrides:

rmdir in class TransferModule

Parameters:

dir - the dir

Throws:

IOException - Signals that an I/O exception has occurred.

size

public long size(String name)
          throws IOException

Give the size of the file given by its name. Size.

Specified by:

size in class TransferModule

Parameters:

name - the name

Returns:

the long

Throws:

IOException - Signals that an I/O exception has occurred.

move

public void move(String source,
 String target)
          throws IOException

Move source to target. Move.

Overrides:

move in class TransferModule

Parameters:

source - the source

target - the target

Throws:

IOException - Signals that an I/O exception has occurred.

prePut

public String prePut(String name,
 String tmpName,
 long posn)
              throws IOException

Pre-put. When using an external module to transfer files this method is called first to get the target filename! Pre put.

Overrides:

prePut in class TransferModule

Parameters:

name - the name

tmpName - the tmp name

posn - the posn

Returns:

the string

Throws:

IOException - Signals that an I/O exception has occurred.

put

public OutputStream put(String name,
 long posn,
 long size)
                 throws IOException

Provide an output stream to write the content of the file given by its name starting at position posn. Put.

Specified by:

put in class TransferModule

Parameters:

name - the name

posn - the posn

size - the size

Returns:

the output stream

Throws:

IOException - Signals that an I/O exception has occurred.

put

public boolean put(InputStream in,
 String name,
 long posn,
 long size)
            throws IOException

Write the content of the file given by its name, starting at position posn and writing to the provided input stream. By default, doing nothing and returning false. Put.

Overrides:

put in class TransferModule

Parameters:

in - the in

name - the name

posn - the posn

size - the size

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

check

public void check(long sent,
 String checksum)
           throws IOException

Check if the last put was successful comparing the number of bytes sent and the checksum provided to the one calculated. By default, doing nothing. Check.

Overrides:

check in class TransferModule

Parameters:

sent - the sent

checksum - the checksum

Throws:

IOException - Signals that an I/O exception has occurred.

exec

public int exec(String command)
         throws com.jcraft.jsch.JSchException,
IOException

Exec.

Parameters:

command - the command

Returns:

the int

Throws:

com.jcraft.jsch.JSchException - the j sch exception

IOException - Signals that an I/O exception has occurred.

preGet

public void preGet(String name,
 long posn)
            throws IOException

Pre-get. When using an external module to transfer files this method is called first. Pre get.

Overrides:

preGet in class TransferModule

Parameters:

name - the name

posn - the posn

Throws:

IOException - Signals that an I/O exception has occurred.

get

public InputStream get(String name,
 long posn)
                throws IOException

Gets the input stream to read the file given by name starting at posn. Gets the.

Specified by:

get in class TransferModule

Parameters:

name - the name

posn - the posn

Returns:

the input stream

Throws:

IOException - Signals that an I/O exception has occurred.

get

public boolean get(OutputStream out,
 String name,
 long posn)
            throws IOException

Gets the content of the file given by name written to the provided output stream, starting at posn. By default, doing nothing and returning false. Gets the.

Overrides:

get in class TransferModule

Parameters:

out - the out

name - the name

posn - the posn

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

listAsStringArray

public String[] listAsStringArray(String directory,
 String pattern)
                           throws IOException

List as a string array. List as string array.

Overrides:

listAsStringArray in class TransferModule

Parameters:

directory - the directory

pattern - the pattern

Returns:

the string[]

Throws:

IOException - Signals that an I/O exception has occurred.

close

public void close()
           throws IOException

Close.

Throws:

IOException