Class SshResponse

java.lang.Object

io.gem.api.SshResponse

public final class SshResponse
extends Object

Mutable holder for SSH command execution streams and exit code.

Used by SshUtils.runCommand(org.apache.sshd.client.session.ClientSession, String, long, SshResponse) to channel stdout/stderr and record the return code.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_DIAGNOSTIC_BYTES	Maximum stdout or stderr bytes retained for one remote command.
final OutputStream	errOutputStream	OutputStream errOutputStream.
int	returnCode	int returnCode.
final OutputStream	stdOutputStream	OutputStream stdOutputStream.

Constructor Summary

Constructors

Constructor	Description
SshResponse(boolean stdout)	Create response streams.
SshResponse(boolean stdout, int diagnosticBytes)	Create response streams with an explicit diagnostic limit.

Method Summary

Methods inherited from class Object

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

Field Details

DEFAULT_DIAGNOSTIC_BYTES

public static final int DEFAULT_DIAGNOSTIC_BYTES

Maximum stdout or stderr bytes retained for one remote command.

See Also:

• Constant Field Values

errOutputStream

public final OutputStream errOutputStream

OutputStream errOutputStream.

stdOutputStream

public final OutputStream stdOutputStream

OutputStream stdOutputStream.

returnCode

public int returnCode

int returnCode.

Constructor Details

SshResponse

public SshResponse(boolean stdout)

Create response streams.

Parameters:

stdout - if true, allocate a buffer for stdout; otherwise discard to a null stream

SshResponse

public SshResponse(boolean stdout,
 int diagnosticBytes)

Create response streams with an explicit diagnostic limit.

Parameters:

stdout - if true, retain bounded stdout; otherwise discard stdout

diagnosticBytes - maximum bytes retained independently for stdout and stderr