Constructor and description |
---|
SshUtilService
() |
Type | Name and description |
---|---|
int |
cd(SSHUtil sshUtil, java.lang.String strFolderName) |
boolean |
changeWorkingDirectory(SSHUtil sshUtil, java.lang.String pathname) |
void |
createRemoteDirs(ch.ethz.ssh2.Connection conn, ch.ethz.ssh2.SFTPv3Client sc, java.lang.String path) |
void |
createRemoteDirs(SSHUtil sshUtil, java.lang.String path) createRemoteDirs remotely |
void |
del(SSHUtil sshUtil, java.lang.String remoteFile) |
void |
deleteRemoteFile(java.lang.String pathName, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) Deletes a remote file |
void |
deleteRemoteFile(SSHUtil sshUtil, java.lang.String remoteFile) |
java.util.List<java.lang.String> |
dir(SSHUtil sshUtil) |
java.util.List<java.lang.String> |
dir(SSHUtil sshUtil, java.lang.String strFolderName) |
java.util.List<java.lang.String> |
dir(SSHUtil sshUtil, java.lang.String strFolderName, int flag) |
void |
disconnect(SSHUtil sshUtil) |
void |
disconnectConnection(ch.ethz.ssh2.Connection conn, boolean closeConnection = true) Will decide on if closeConnection is provided if so will close connection |
java.lang.String |
execute(ch.ethz.ssh2.Connection conn = null, java.lang.String cmd, boolean closeConnection = false) Execute a command |
java.lang.String |
execute(SSHUtil sshUtil, java.lang.String cmd) //sshUtil.cmd=cmd //return sshUtil.execute() |
boolean |
fileExists(java.lang.String filename, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) checks to see if file exists |
boolean |
fileExists(SSHUtil sshUtil, java.lang.String filename) sshUtil.localFile=fileName boolean fileExists = sshUtil.fileExists() |
private groovy.util.ConfigObject |
getConfig() |
void |
getFile(java.lang.String remoteFilePath, java.lang.String localFolder, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false, java.lang.String characterSet = null) |
void |
getFile(SSHUtil sshUtil, java.lang.String remoteFilePath, java.lang.String localFolder) Examples other than below: |
java.util.List<java.lang.String> |
getFileNames(SSHUtil sshUtil) |
java.util.List<java.lang.String> |
getFileNames(SSHUtil sshUtil, boolean recursive) |
java.util.List<java.lang.String> |
getFileNames(SSHUtil sshUtil, java.lang.String pathname) |
java.util.List<java.lang.String> |
getFileNames(SSHUtil sshUtil, java.lang.String pathname, boolean recursive) |
void |
getFiles(java.util.List<java.lang.String> files, java.lang.String localFolder, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) |
void |
getFiles(SSHUtil sshUtil, java.util.List<java.lang.String> files, java.lang.String localFolder) |
SSHUtil |
getInitialise() 0.10 introduces initialise which simplifies and wraps requirements in SSHUtil class with initialise connection, SCPClient and SFTPv3Client are all initiated @return |
ch.ethz.ssh2.Connection |
getOpenConnection() runs default no host no port which finds as per configuration file or defaults |
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) |
boolean |
isDirectory(SSHUtil sshUtil, java.lang.String folderName) |
boolean |
isHiddenFile(SSHUtil sshUtil, java.lang.String strFileName) |
boolean |
isNotHiddenFile(SSHUtil sshUtil, java.lang.String strFileName) |
java.util.List<java.lang.String> |
listFiles(SSHUtil sshUtil, java.lang.String pathname, boolean recurseSubFolder) |
java.util.List<java.lang.String> |
listFiles(SSHUtil sshUtil) |
java.util.List<java.lang.String> |
listNames(SSHUtil sshUtil, java.lang.String pathname) |
void |
mkDirs(SSHUtil sshUtil, java.lang.String remoteDir) |
void |
mkdir(SSHUtil sshUtil, java.lang.String remoteDir) |
ch.ethz.ssh2.Connection |
openConnection(java.lang.String host = null, int port = 0) @param host - optional |
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, int port, java.lang.String username, java.lang.String password) openConnection(host,port,username,pass) |
void |
put(SSHUtil sshUtil, java.lang.String localFile, java.lang.String remoteFile) |
void |
putFile(java.lang.String localFile, java.lang.String remoteDir, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false, java.lang.String characterSet = null) Very similar to writeFile except SFTPv3Client is used slightly differently to write file |
long |
putFile(SSHUtil sshUtil, java.lang.String localFile, java.io.OutputStream out) |
void |
putFile(SSHUtil sshUtil, java.lang.String localFile, java.lang.String remoteDir) sshUtik.remoteDir=remoteDir sshUtil.localFile=localFile sshUtil.putFile() |
void |
putFiles(java.util.List<java.lang.String> localFilePaths, java.lang.String remoteFolder, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) |
void |
putFiles(SSHUtil sshUtil, java.util.List<java.lang.String> localFilePaths, java.lang.String remoteFolder) |
java.lang.String |
readFile(java.lang.String remoteFile, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) |
java.lang.String |
readFile(SSHUtil sshUtil, java.lang.String remoteFile) This is using SFTPv3Client to read file |
java.lang.String |
readRemoteFile(java.lang.String remoteFile, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) |
java.lang.String |
readRemoteFile(SSHUtil sshUtil, java.lang.String remoteFile) This is using SCPClient to read remote file //sshUtil.remoteFile=remoteFile //sshUtil.readRemoteFile() |
long |
remoteFileSize(java.lang.String remoteFile, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false) |
long |
remoteFileSize(SSHUtil sshUtil, java.lang.String remoteFile) //sshUtil.remoteFile=remoteFile //return sshUtil.remoteFileSize() |
void |
rmdir(SSHUtil sshUtil, java.lang.String remoteDir) |
void |
rmdir(SSHUtil sshUtil, java.lang.String remoteDir, boolean recursive) |
ch.ethz.ssh2.SFTPv3Client |
sftpClient(ch.ethz.ssh2.Connection connection, java.lang.String characterSet = null) |
java.lang.Object |
threadedExecutor(groovy.lang.Closure closure) |
java.lang.Object |
threadedExecutor(groovy.lang.Closure closure, Priority priority) |
java.lang.Object |
threadedExecutor(SSHUtil sshUtil, groovy.lang.Closure closure) |
java.lang.Object |
threadedExecutor(SSHUtil sshUtil, Priority priority, groovy.lang.Closure closure) |
java.lang.Object |
threadedExecutor(SSHUtil sshUtil, ch.ethz.ssh2.Connection connection, groovy.lang.Closure closure) |
java.lang.Object |
threadedExecutor(SSHUtil sshUtil, ch.ethz.ssh2.Connection connection, Priority priority, groovy.lang.Closure closure) |
void |
writeFile(java.lang.String localFile, java.lang.String remoteDir, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false, java.lang.String characterSet = null) writes a file to remote server |
void |
writeFile(SSHUtil sshUtil, java.lang.String localFile, java.lang.String remoteDir) simplified version of original above |
void |
writeFileWithName(java.lang.String localFile, java.lang.String remoteFile, ch.ethz.ssh2.Connection connection = null, boolean closeConnection = false, java.lang.String characterSet = null) |
void |
writeFileWithName(SSHUtil sshUtil, java.lang.String localFile, java.lang.String remoteFile) Other ways: //sshUtil.localFile=localFile //sshUtil.remoteFile=remoteFile //return sshUtil.writeFileWithName() |
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() |
createRemoteDirs remotely
Deletes a remote file
Will decide on if closeConnection is provided if so will close connection
Execute a command
//sshUtil.cmd=cmd //return sshUtil.execute()
checks to see if file exists
sshUtil.localFile=fileName boolean fileExists = sshUtil.fileExists()
Examples other than below: //sshUtil.localDir=localFolder //sshUtil.remoteFile=remoteFilePath //return sshUtil.getFile()
0.10 introduces initialise which simplifies and wraps requirements in SSHUtil class with initialise connection, SCPClient and SFTPv3Client are all initiated
runs default no host no port which finds as per configuration file or defaults
host
- - optionalport
- - optional
Returns a default connection bound to local host
It can be called as
// this binds to HOST config or localhost
// then binds config ports key/pass password username etc
sshUtilService.openConnection
or
sshUtilService.getOpenConnection("10.0.0.1") //defaults port to PORT config or 22
or
sshUtilService.getOpenConnection("10.0.0.1",32) //where it connects to 10.0.0.1 on port 32openConnection(host,port,username,keyfile,keyfilepass)
openConnection(host,port,username,pass)
Very similar to writeFile except SFTPv3Client is used slightly differently to write file
sshUtik.remoteDir=remoteDir sshUtil.localFile=localFile sshUtil.putFile()
This is using SFTPv3Client to read file //sshUtil.remoteFile=remoteFile //return sshUtil.readFile()
This is using SCPClient to read remote file //sshUtil.remoteFile=remoteFile //sshUtil.readRemoteFile()
//sshUtil.remoteFile=remoteFile //return sshUtil.remoteFileSize()
writes a file to remote server
simplified version of original above Other ways //sshUtil.localFile=localFile //sshUtil.remoteDir=remoteDir //sshUtil.writeFile()
Other ways: //sshUtil.localFile=localFile //sshUtil.remoteFile=remoteFile //return sshUtil.writeFileWithName()
Groovy Documentation