Module com.sshteam.lib

Package com.sshteam.lib

Class SshKeyCleanAutomation

java.lang.Object

com.sshteam.lib.AbstractSshAutomation

com.sshteam.lib.SshKeyCleanAutomation

Direct Known Subclasses:

SshKeyDeployAutomation

public class SshKeyCleanAutomation
extends AbstractSshAutomation

Field Summary

Fields

Modifier and Type	Field	Description
protected com.sshtools.common.config.AdaptiveConfiguration	adaptiveConfiguration
protected final boolean	confirmConfigChanges
protected String	id
protected final String	keyServer
protected final int	keyServerPort
protected Platform	platform
protected com.sshtools.client.sftp.SftpClient	sftp
protected String	version

Fields inherited from class com.sshteam.lib.AbstractSshAutomation

ssh

Method Summary

Modifier and Type	Method	Description
protected void	afterCommand(com.sshtools.sequins.Progress progress)
protected boolean	checkInstalled(com.sshtools.sequins.Progress progress)
protected void	doCommand(com.sshtools.sequins.Progress progress)
protected String	execute(String cmd)
protected String	execute(String cmd, boolean assertSuccess, String errorMessage)
protected String	getConfig(String key, String defaultValue)
protected String	getHomeDirectory(Platform platform)
protected String	getInstallPath()
protected String	getSshdConfigPath()
protected com.sshtools.common.sshd.config.SshdConfigFile	getTeamConfig()
protected String	getTeamConfigPath()
protected com.sshtools.common.sshd.config.SshdConfigFile	loadConfiguration(com.sshtools.sequins.Progress progress, String path)
protected void	restartService(com.sshtools.sequins.Progress progress)
protected final int	runCommand(com.sshtools.sequins.Progress progress)
protected void	runInShell(Runnable task)
protected void	saveConfiguration(com.sshtools.sequins.Progress progress, com.sshtools.common.sshd.config.SshdConfigFile config, String configPath)
protected int	sudoWithExitCode(String cmd, boolean assertSuccess)
protected int	sudoWithExitCode(String cmd, boolean assertSuccess, String errorMessage)
protected String	sudoWithOutput(String cmd, boolean assertSuccess)
protected boolean	uninstallDependencies(com.sshtools.sequins.Progress progress)

Methods inherited from class com.sshteam.lib.AbstractSshAutomation

beforeCommand, call, connect, getAgentSocket, getAuthenticationTimeout, getCachedPasswordOrPrompt, getCommandName, getHost, getIdentityFile, getPassphraseSupplier, getPasswordSupplier, getPort, getPrompter, getSsh, getUsername, isAgentAuthentication, isDefaultIdentities, isPasswordAuthentication, isRoot, isVerboseProgress, onConnected, readPassword, readPassword

Methods inherited from class java.lang.Object

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

Field Details

sftp

protected com.sshtools.client.sftp.SftpClient sftp

id

protected String id

version

protected String version

platform

protected Platform platform

adaptiveConfiguration

protected com.sshtools.common.config.AdaptiveConfiguration adaptiveConfiguration

keyServer

protected final String keyServer

keyServerPort

protected final int keyServerPort

confirmConfigChanges

protected final boolean confirmConfigChanges

Method Details

runCommand

protected final int runCommand(com.sshtools.sequins.Progress progress)

Specified by:

runCommand in class AbstractSshAutomation

runInShell

protected void runInShell(Runnable task)
                   throws IOException

Throws:

IOException

doCommand

protected void doCommand(com.sshtools.sequins.Progress progress)
                  throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException,
com.sshtools.common.sftp.SftpStatusException,
com.sshtools.client.sftp.TransferCancelledException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

com.sshtools.common.sftp.SftpStatusException

com.sshtools.client.sftp.TransferCancelledException

afterCommand

protected void afterCommand(com.sshtools.sequins.Progress progress)

Overrides:

afterCommand in class AbstractSshAutomation

checkInstalled

protected boolean checkInstalled(com.sshtools.sequins.Progress progress)

getInstallPath

protected String getInstallPath()

uninstallDependencies

protected boolean uninstallDependencies(com.sshtools.sequins.Progress progress)
                                 throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

getTeamConfigPath

protected String getTeamConfigPath()

getTeamConfig

protected com.sshtools.common.sshd.config.SshdConfigFile getTeamConfig()
                                                                throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

getSshdConfigPath

protected String getSshdConfigPath()
                            throws com.sshtools.client.shell.ShellTimeoutException,
com.sshtools.common.ssh.SshException,
IOException

Throws:

com.sshtools.client.shell.ShellTimeoutException

com.sshtools.common.ssh.SshException

IOException

loadConfiguration

protected com.sshtools.common.sshd.config.SshdConfigFile loadConfiguration(com.sshtools.sequins.Progress progress,
 String path)
                                                                    throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

saveConfiguration

protected void saveConfiguration(com.sshtools.sequins.Progress progress,
 com.sshtools.common.sshd.config.SshdConfigFile config,
 String configPath)
                          throws com.sshtools.common.sftp.SftpStatusException,
com.sshtools.common.ssh.SshException,
IOException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

com.sshtools.common.sftp.SftpStatusException

com.sshtools.common.ssh.SshException

IOException

com.sshtools.client.shell.ShellTimeoutException

restartService

protected void restartService(com.sshtools.sequins.Progress progress)
                       throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

getHomeDirectory

protected String getHomeDirectory(Platform platform)
                           throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

sudoWithOutput

protected String sudoWithOutput(String cmd,
 boolean assertSuccess)
                         throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

sudoWithExitCode

protected int sudoWithExitCode(String cmd,
 boolean assertSuccess)
                        throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

sudoWithExitCode

protected int sudoWithExitCode(String cmd,
 boolean assertSuccess,
 String errorMessage)
                        throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

execute

protected String execute(String cmd)
                  throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

execute

protected String execute(String cmd,
 boolean assertSuccess,
 String errorMessage)
                  throws IOException,
com.sshtools.common.ssh.SshException,
com.sshtools.client.shell.ShellTimeoutException

Throws:

IOException

com.sshtools.common.ssh.SshException

com.sshtools.client.shell.ShellTimeoutException

getConfig

protected String getConfig(String key,
 String defaultValue)