com.trilead.ssh2.jenkins

Class SFTPClient

java.lang.Object

com.trilead.ssh2.SFTPv3Client

com.trilead.ssh2.jenkins.SFTPClient

public class SFTPClient
extends SFTPv3Client

This Class adds file manage capabilities to the SFTPv3Client class.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
SFTPClient(Connection conn)

Method Summary

Modifier and Type	Method and Description
SFTPv3FileAttributes	_stat(String path) Graceful SFTPv3Client.stat(String) that returns null if the path doesn't exist.
void	chmod(String path, int permissions) Change file or directory permissions.
boolean	exists(String path) Checks if the given path exists.
void	mkdirs(String path, int posixPermission) Makes sure that the directory exists, by creating it if necessary.
InputStream	read(String file) Read input stream.
OutputStream	writeToFile(String path) Creates a new file and writes to it.

Methods inherited from class com.trilead.ssh2.SFTPv3Client

canonicalPath, close, closeFile, createFile, createFile, createFileTruncate, createFileTruncate, createSymlink, fsetstat, fstat, getCharset, getProtocolVersion, ls, lstat, mkdir, mv, openFileRO, openFileRW, read, readLink, rm, rmdir, setCharset, setstat, stat, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SFTPClient

public SFTPClient(Connection conn)
           throws IOException

Throws:

IOException

Method Detail

exists

public boolean exists(String path)
               throws IOException

Checks if the given path exists.

Overrides:

exists in class SFTPv3Client

Parameters:

path - directory or file path.

Returns:

true if it exists.

Throws:

IOException - if it is not possible to access to the directory or file .

_stat

public SFTPv3FileAttributes _stat(String path)
                           throws IOException

Graceful SFTPv3Client.stat(String) that returns null if the path doesn't exist.

Overrides:

_stat in class SFTPv3Client

Parameters:

path - directory path.

Returns:

the sft pv 3 file attributes

Throws:

IOException - if it is not possible to access to the directory.

mkdirs

public void mkdirs(String path,
                   int posixPermission)
            throws IOException

Makes sure that the directory exists, by creating it if necessary.

Overrides:

mkdirs in class SFTPv3Client

Parameters:

path - directory path.

posixPermission - POSIX permissions.

Throws:

IOException - if it is not possible to access to the directory.

writeToFile

public OutputStream writeToFile(String path)
                         throws IOException

Description copied from class: SFTPv3Client

Creates a new file and writes to it.

Overrides:

writeToFile in class SFTPv3Client

Parameters:

path - file path.

Returns:

Creates a new file and return an OutputStream to writes to it.

Throws:

IOException - if it is not possible to access to the file.

read

public InputStream read(String file)
                 throws IOException

Description copied from class: SFTPv3Client

Read input stream.

Overrides:

read in class SFTPv3Client

Parameters:

file - file path.

Returns:

return an InputStream to the file.

Throws:

IOException - if it is not possible to access to the file.

chmod

public void chmod(String path,
                  int permissions)
           throws IOException

Change file or directory permissions.

Overrides:

chmod in class SFTPv3Client

Parameters:

path - file or directory path.

permissions - POSIX permissions.

Throws:

IOException - in case of error.