Class SshCommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

io.gem.api.SshCommandException

All Implemented Interfaces:

Serializable

public final class SshCommandException
extends IOException

Host-tagged SSH command failure retaining bounded command diagnostics.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SshCommandException(String host, SshResponse response, boolean timeout, IOException cause)	Create a remote command failure.

Method Summary

Modifier and Type	Method	Description
String	getHost()	Return the remote host.
SshResponse	getResponse()	Return partial bounded command output.
boolean	isTimeout()	Check whether the command deadline expired.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Constructor Details

SshCommandException

public SshCommandException(String host,
 SshResponse response,
 boolean timeout,
 IOException cause)

Create a remote command failure.

Parameters:

host - remote host

response - partial bounded stdout and stderr

timeout - whether command execution timed out

cause - underlying SSH failure

Method Details

getHost

public String getHost()

Return the remote host.

Returns:

remote host name or address

getResponse

public SshResponse getResponse()

Return partial bounded command output.

Returns:

command response populated before transport failure

isTimeout

public boolean isTimeout()

Check whether the command deadline expired.

Returns:

true for a command timeout