SSHUtil (Groovy Documentation)

grails.plugin.remotessh.SSHUtil

Utility class that binds into SshUtilService and does all the work It is based flexible so it can either be instantiated or just called direct through service which instantiates once and reused if used correctly. Since service left rather flexible in ways things can be called
Authors:
Vahid Hedayati 27th March 2019

Field Summary

Fields
Modifiers	Name	Description
`private static int`	`BUFSIZE`
`private java.lang.String`	`FS`
`static int`	`S_IFDIR`
`static int`	`S_IFMT`
`private java.lang.String`	`currentDirectory`
`private static org.slf4j.Logger`	`log`
`protected java.lang.String`	`reply`

Properties Summary

Properties
Type	Name and description
`java.io.File`	`actualFile`
`java.util.Map`	`cfg`
`java.lang.String`	`characterSet`
`ch.ethz.ssh2.SFTPv3Client`	`client`
`java.lang.String`	`cmd`
`java.lang.String`	`configVariable`
`ch.ethz.ssh2.Connection`	`connection`
`ch.ethz.ssh2.SFTPv3FileHandle`	`handle`
`java.lang.String`	`localDir`
`java.lang.String`	`localFile`
`java.lang.String`	`remoteDir`
`java.lang.String`	`remoteFile`
`ch.ethz.ssh2.SCPClient`	`scpClient`
`boolean`	`singleInstance`

Constructor Summary

Constructors
Constructor and description
`SSHUtil ()`
`SSHUtil (ch.ethz.ssh2.Connection connection, boolean singleInstance = false, java.lang.String characterSet = null)`
`SSHUtil (ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, boolean singleInstance = false)`
`SSHUtil (ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, ch.ethz.ssh2.SFTPv3FileHandle handle, boolean singleInstance = false)`

Methods Summary

Methods
Type	Name and description
`int`	`DoCD(java.lang.String strFolderName)`
`java.lang.String`	`addFileSeparator(java.lang.String str)`
`int`	`cd(java.lang.String directory)`
`boolean`	`changeWorkingDirectory(java.lang.String pathname)`
`void`	`closeHandle(boolean override = true)`
`void`	`createRemoteDirs(java.lang.String remotedir = null)`
`void`	`del(java.lang.String pathName)`
`void`	`deleteRemoteFile(java.lang.String pathName)`
`java.util.List<java.lang.String>`	`dir()`
`java.util.List<java.lang.String>`	`dir(java.lang.String pathname)`
`java.util.List<java.lang.String>`	`dir(java.lang.String pathname, int flag)`
`void`	`disconnect()`
`java.lang.String`	`execute(java.lang.String command = null)`
`boolean`	`fileExists(java.lang.String filename = null)`
`long`	`fileSize(java.lang.String remotefile = null)`
`void`	`finaliseConnection(boolean override = false)` decides if single instance and closes sftp client as well as ssh2 connection to server
`java.lang.String`	`getBinaryPermission(java.lang.String strFileName = null)`
`java.lang.Object`	`getConfig(java.lang.String configProperty)` 0.11 customised to lookup internal configVariable meaning default remotessh config key can be overridden demonstrated in release-0.10.md
`int`	`getDecimalPermission(java.lang.String strFileName = null)`
`java.util.List<java.lang.String>`	`getDir()`
`java.lang.String`	`getDisconnect()`
`void`	`getFile(java.lang.String remotefile = null, java.lang.String localdir = null, boolean recursive = false)`
`java.util.List<java.lang.String>`	`getFileNames()` return a listing of the contents of a directory in short format on the remote machine (without subdirectory)
`java.util.List<java.lang.String>`	`getFileNames(boolean recurseSubFolders)`
`java.util.List<java.lang.String>`	`getFileNames(java.lang.String pathname)`
`java.util.List<java.lang.String>`	`getFileNames(java.lang.String pstrPathName, boolean recurseSubFolders)`
`java.lang.Integer`	`getFilePermission(java.lang.String strFileName)`
`java.lang.String`	`getFileUserId(java.lang.String strFileName)`
`void`	`getFiles(java.util.List<java.lang.String> files, java.lang.String localfolder = null)`
`SSHUtil`	`getInitialise()`
`java.util.List<java.lang.String>`	`getListFiles()`
`java.util.List<java.lang.String>`	`getLs()` return a listing of the contents of a directory in short format on the remote machine
`void`	`getMkDirs()`
`java.util.Date`	`getModificationDateTime(java.lang.String strFileName)`
`java.lang.String`	`getOctalPermission(java.lang.String strFileName = null)`
`ch.ethz.ssh2.Connection`	`getOpenConnection()`
`java.lang.String`	`getPermission(java.lang.String strFileName = null)`
`static ch.ethz.ssh2.SCPClient`	`getScpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null)`
`SSHUtil`	`initialise(boolean singleInstance = false)`
`SSHUtil`	`initialise(java.lang.String host, int port, boolean singleInstance = false)`
`SSHUtil`	`initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, boolean singleInstance = false)`
`SSHUtil`	`initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, boolean singleInstance = false)`
`SSHUtil`	`initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)`
`SSHUtil`	`initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)`
`private void`	`initialiseRemoteFile(java.lang.String localfile = null, java.lang.String remotedir = null, boolean overrideRemoteFile = false)`
`boolean`	`isDirectory(java.lang.String filename)`
`boolean`	`isHiddenFile(java.lang.String pstrFolderName)`
`boolean`	`isNotHiddenFile(java.lang.String strFileName)`
`java.util.List<java.lang.String>`	`listFiles(java.lang.String pathname, boolean recurseSubFolder)`
`java.util.List<java.lang.String>`	`listFiles()`
`java.util.List<java.lang.String>`	`listFiles(boolean recursive)` return a listing of the contents of a directory in short format on the remote machine
`java.util.List<java.lang.String>`	`listFiles(java.lang.String pathname)`
`java.util.List<java.lang.String>`	`listNames(java.lang.String pathname)`
`void`	`mkDirs(java.lang.String remotedir = null)`
`void`	`mkdir(java.lang.String pstrPathName)` Creates a new subdirectory on the FTP server in the current directory .
`static ch.ethz.ssh2.Connection`	`openConnection(java.lang.String host, int port, java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass)` openConnection(host,port,username,keyfile,keyfilepass)
`ch.ethz.ssh2.Connection`	`openConnection(java.lang.String host = null, int port = 0)`
`static ch.ethz.ssh2.Connection`	`openConnection(java.lang.String host, int port, java.lang.String username, java.lang.String password)` openConnection(host,port,username,pass)
`ch.ethz.ssh2.SFTPv3FileHandle`	`openFileRO(java.lang.String pstrFilename)`
`ch.ethz.ssh2.SFTPv3FileHandle`	`openFileWR(java.lang.String pstrFilename)`
`void`	`put(java.lang.String localFile, java.lang.String remoteFile)`
`long`	`putFile(java.lang.String localfile = null, java.lang.String remotedir = null, boolean recursive = false)`
`long`	`putFile(java.lang.String localFile, java.io.OutputStream out)`
`void`	`putFiles(java.util.List<java.lang.String> localFilePaths, java.lang.String remotefolder = null)`
`java.lang.String`	`readFile(java.lang.String givenFile = null)`
`java.lang.String`	`readRemoteFile(java.lang.String givenFile = null)` Reads string content of remote file
`long`	`remoteFileSize(java.lang.String remotefile = null)`
`private java.lang.String`	`resolvePathname(java.lang.String pathname)`
`void`	`rmdir(java.lang.String pstrPathName, boolean recursive = true)` Removes a directory on the FTP server (if empty).
`void`	`setFilePermission(java.lang.String strFileName, int newPermission)`
`void`	`setFilePermission(java.lang.String strFileName, java.lang.String newPermission)`
`void`	`setFileUserId(java.lang.String strFileName, int uid)` Your end user needs to have sufficient privileges The user does not have sufficient permissions to perform the operation.
`long`	`setModificationDateTime(java.lang.String file, long pdteDateTime)`
`void`	`setModificationDateTime(java.lang.String file, java.util.Date date)`
`static ch.ethz.ssh2.SFTPv3Client`	`sftpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null)`
`java.lang.String`	`splitPermission(java.lang.String line)`
`private java.lang.String`	`trimResponseCode(java.lang.String response)`
`void`	`writeFile(java.lang.String localfile = null, java.lang.String remotedir = null)`
`void`	`writeFileWithName(java.lang.String localfile = null, java.lang.String remotefile = null)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private static final int BUFSIZE
  - private java.lang.String FS
  - public static final int S_IFDIR
  - public static final int S_IFMT
  - private java.lang.String currentDirectory
  - private static final org.slf4j.Logger log
  - protected java.lang.String reply
- Property Detail
  - java.io.File actualFile
  - java.util.Map cfg
  - java.lang.String characterSet
  - ch.ethz.ssh2.SFTPv3Client client
  - java.lang.String cmd
  - java.lang.String configVariable
  - ch.ethz.ssh2.Connection connection
  - ch.ethz.ssh2.SFTPv3FileHandle handle
  - java.lang.String localDir
  - java.lang.String localFile
  - java.lang.String remoteDir
  - java.lang.String remoteFile
  - ch.ethz.ssh2.SCPClient scpClient
  - boolean singleInstance
- Constructor Detail
  - SSHUtil()
  - SSHUtil(ch.ethz.ssh2.Connection connection, boolean singleInstance = false, java.lang.String characterSet = null)
  - SSHUtil(ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, boolean singleInstance = false)
  - SSHUtil(ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, ch.ethz.ssh2.SFTPv3FileHandle handle, boolean singleInstance = false)
- Method Detail
  - int DoCD(java.lang.String strFolderName)
  - java.lang.String addFileSeparator(java.lang.String str)
  - int cd(java.lang.String directory)
  - boolean changeWorkingDirectory(java.lang.String pathname)
  - void closeHandle(boolean override = true)
  - void createRemoteDirs(java.lang.String remotedir = null)
  - void del(java.lang.String pathName)
  - void deleteRemoteFile(java.lang.String pathName)
  - java.util.List<java.lang.String> dir()
  - java.util.List<java.lang.String> dir(java.lang.String pathname)
  - java.util.List<java.lang.String> dir(java.lang.String pathname, int flag)
  - void disconnect()
  - java.lang.String execute(java.lang.String command = null)
  - boolean fileExists(java.lang.String filename = null)
  - long fileSize(java.lang.String remotefile = null)
  - void finaliseConnection(boolean override = false)
    
    decides if single instance and closes sftp client as well as ssh2 connection to server
  - java.lang.String getBinaryPermission(java.lang.String strFileName = null)
  - java.lang.Object getConfig(java.lang.String configProperty)
    
    0.11 customised to lookup internal configVariable meaning default remotessh config key can be overridden demonstrated in release-0.10.md
    Parameters:
    configProperty
    Returns:
  - int getDecimalPermission(java.lang.String strFileName = null)
  - java.util.List<java.lang.String> getDir()
  - java.lang.String getDisconnect()
  - void getFile(java.lang.String remotefile = null, java.lang.String localdir = null, boolean recursive = false)
  - java.util.List<java.lang.String> getFileNames()
    
    return a listing of the contents of a directory in short format on the remote machine (without subdirectory)
    Throws:
    Exception
    Returns:
    a listing of the contents of a directory on the remote machine
    See Also:
    nList( String )
    dir()
    dir( String )
  - java.util.List<java.lang.String> getFileNames(boolean recurseSubFolders)
  - java.util.List<java.lang.String> getFileNames(java.lang.String pathname)
  - java.util.List<java.lang.String> getFileNames(java.lang.String pstrPathName, boolean recurseSubFolders)
  - java.lang.Integer getFilePermission(java.lang.String strFileName)
  - java.lang.String getFileUserId(java.lang.String strFileName)
  - void getFiles(java.util.List<java.lang.String> files, java.lang.String localfolder = null)
  - SSHUtil getInitialise()
  - java.util.List<java.lang.String> getListFiles()
  - java.util.List<java.lang.String> getLs()
    
    return a listing of the contents of a directory in short format on the remote machine
    Throws:
    Exception
    Returns:
    a listing of the contents of a directory on the remote machine
    See Also:
    nList( String )
    dir()
    dir( String )
  - void getMkDirs()
  - java.util.Date getModificationDateTime(java.lang.String strFileName)
  - java.lang.String getOctalPermission(java.lang.String strFileName = null)
  - ch.ethz.ssh2.Connection getOpenConnection()
  - java.lang.String getPermission(java.lang.String strFileName = null)
  - static ch.ethz.ssh2.SCPClient getScpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null)
  - SSHUtil initialise(boolean singleInstance = false)
  - SSHUtil initialise(java.lang.String host, int port, boolean singleInstance = false)
  - SSHUtil initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, boolean singleInstance = false)
  - SSHUtil initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, boolean singleInstance = false)
  - SSHUtil initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)
  - SSHUtil initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)
  - private void initialiseRemoteFile(java.lang.String localfile = null, java.lang.String remotedir = null, boolean overrideRemoteFile = false)
  - boolean isDirectory(java.lang.String filename)
  - boolean isHiddenFile(java.lang.String pstrFolderName)
  - boolean isNotHiddenFile(java.lang.String strFileName)
  - java.util.List<java.lang.String> listFiles(java.lang.String pathname, boolean recurseSubFolder)
  - java.util.List<java.lang.String> listFiles()
  - java.util.List<java.lang.String> listFiles(boolean recursive)
    
    return a listing of the contents of a directory in short format on the remote machine
    Throws:
    Exception
    Returns:
    a listing of the contents of a directory on the remote machine
    See Also:
    nList( String )
    dir()
    dir( String )
  - java.util.List<java.lang.String> listFiles(java.lang.String pathname)
  - java.util.List<java.lang.String> listNames(java.lang.String pathname)
  - void mkDirs(java.lang.String remotedir = null)
  - void mkdir(java.lang.String pstrPathName)
    
    Creates a new subdirectory on the FTP server in the current directory .
    throws:
    java.lang.IOException
    
    Parameters:
    pstrPathName - The pathname of the directory to create.
    Returns:
    True if successfully completed, false if not.
  - static ch.ethz.ssh2.Connection openConnection(java.lang.String host, int port, java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass)
    
    openConnection(host,port,username,keyfile,keyfilepass)
    Parameters:
    host
    port
    username
    keyfile
    keyfilePass
    Returns:
    ssh2 Connection
  - ch.ethz.ssh2.Connection openConnection(java.lang.String host = null, int port = 0)
  - static ch.ethz.ssh2.Connection openConnection(java.lang.String host, int port, java.lang.String username, java.lang.String password)
    
    openConnection(host,port,username,pass)
    Parameters:
    host
    port
    username
    password
    Returns:
    ssh2 connection
  - ch.ethz.ssh2.SFTPv3FileHandle openFileRO(java.lang.String pstrFilename)
  - ch.ethz.ssh2.SFTPv3FileHandle openFileWR(java.lang.String pstrFilename)
  - void put(java.lang.String localFile, java.lang.String remoteFile)
  - long putFile(java.lang.String localfile = null, java.lang.String remotedir = null, boolean recursive = false)
  - long putFile(java.lang.String localFile, java.io.OutputStream out)
  - void putFiles(java.util.List<java.lang.String> localFilePaths, java.lang.String remotefolder = null)
  - java.lang.String readFile(java.lang.String givenFile = null)
  - java.lang.String readRemoteFile(java.lang.String givenFile = null)
    
    Reads string content of remote file
    Returns:
    @throws Exception
  - long remoteFileSize(java.lang.String remotefile = null)
  - private java.lang.String resolvePathname(java.lang.String pathname)
  - void rmdir(java.lang.String pstrPathName, boolean recursive = true)
    
    Removes a directory on the FTP server (if empty).
    throws:
    java.lang.IOException
    
    Parameters:
    pathname - The pathname of the directory to remove.
  - void setFilePermission(java.lang.String strFileName, int newPermission)
  - void setFilePermission(java.lang.String strFileName, java.lang.String newPermission)
  - void setFileUserId(java.lang.String strFileName, int uid)
    
    Your end user needs to have sufficient privileges The user does not have sufficient permissions to perform the operation.
    Parameters:
    strFileName
    uid
  - long setModificationDateTime(java.lang.String file, long pdteDateTime)
  - void setModificationDateTime(java.lang.String file, java.util.Date date)
  - static ch.ethz.ssh2.SFTPv3Client sftpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null)
  - java.lang.String splitPermission(java.lang.String line)
  - private java.lang.String trimResponseCode(java.lang.String response)
  - void writeFile(java.lang.String localfile = null, java.lang.String remotedir = null)
  - void writeFileWithName(java.lang.String localfile = null, java.lang.String remotefile = null)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class SSHUtil

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final int BUFSIZE

private java.lang.String FS

public static final int S_IFDIR

public static final int S_IFMT

private java.lang.String currentDirectory

private static final org.slf4j.Logger log

protected java.lang.String reply

Property Detail

java.io.File actualFile

java.util.Map cfg

java.lang.String characterSet

ch.ethz.ssh2.SFTPv3Client client

java.lang.String cmd

java.lang.String configVariable

ch.ethz.ssh2.Connection connection

ch.ethz.ssh2.SFTPv3FileHandle handle

java.lang.String localDir

java.lang.String localFile

java.lang.String remoteDir

java.lang.String remoteFile

ch.ethz.ssh2.SCPClient scpClient

boolean singleInstance

Constructor Detail

SSHUtil()

SSHUtil(ch.ethz.ssh2.Connection connection, boolean singleInstance = false, java.lang.String characterSet = null)

SSHUtil(ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, boolean singleInstance = false)

SSHUtil(ch.ethz.ssh2.Connection connection, ch.ethz.ssh2.SFTPv3Client client, ch.ethz.ssh2.SFTPv3FileHandle handle, boolean singleInstance = false)

Method Detail

int DoCD(java.lang.String strFolderName)

java.lang.String addFileSeparator(java.lang.String str)

int cd(java.lang.String directory)

boolean changeWorkingDirectory(java.lang.String pathname)

void closeHandle(boolean override = true)

void createRemoteDirs(java.lang.String remotedir = null)

void del(java.lang.String pathName)

void deleteRemoteFile(java.lang.String pathName)

java.util.List<java.lang.String> dir()

java.util.List<java.lang.String> dir(java.lang.String pathname)

java.util.List<java.lang.String> dir(java.lang.String pathname, int flag)

void disconnect()

java.lang.String execute(java.lang.String command = null)

boolean fileExists(java.lang.String filename = null)

long fileSize(java.lang.String remotefile = null)

void finaliseConnection(boolean override = false)

java.lang.String getBinaryPermission(java.lang.String strFileName = null)

java.lang.Object getConfig(java.lang.String configProperty)

int getDecimalPermission(java.lang.String strFileName = null)

java.util.List<java.lang.String> getDir()

java.lang.String getDisconnect()

void getFile(java.lang.String remotefile = null, java.lang.String localdir = null, boolean recursive = false)

java.util.List<java.lang.String> getFileNames()

java.util.List<java.lang.String> getFileNames(boolean recurseSubFolders)

java.util.List<java.lang.String> getFileNames(java.lang.String pathname)

java.util.List<java.lang.String> getFileNames(java.lang.String pstrPathName, boolean recurseSubFolders)

java.lang.Integer getFilePermission(java.lang.String strFileName)

java.lang.String getFileUserId(java.lang.String strFileName)

void getFiles(java.util.List<java.lang.String> files, java.lang.String localfolder = null)

SSHUtil getInitialise()

java.util.List<java.lang.String> getListFiles()

java.util.List<java.lang.String> getLs()

void getMkDirs()

java.util.Date getModificationDateTime(java.lang.String strFileName)

java.lang.String getOctalPermission(java.lang.String strFileName = null)

ch.ethz.ssh2.Connection getOpenConnection()

java.lang.String getPermission(java.lang.String strFileName = null)

static ch.ethz.ssh2.SCPClient getScpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null)

SSHUtil initialise(boolean singleInstance = false)

SSHUtil initialise(java.lang.String host, int port, boolean singleInstance = false)

SSHUtil initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, boolean singleInstance = false)

SSHUtil initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, boolean singleInstance = false)

SSHUtil initialise(java.lang.String username, java.lang.String password, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)

SSHUtil initialise(java.lang.String username, java.lang.String keyfile, java.lang.String keyfilePass, java.lang.String host, int port, java.lang.String characterSet, boolean singleInstance = false)

private void initialiseRemoteFile(java.lang.String localfile = null, java.lang.String remotedir = null, boolean overrideRemoteFile = false)