Apache Mina SSHD 2.15.0 · org.apache.sshd.client.channel.AbstractClientChannel

Modifier and Type	Class and Description
private static enum	AbstractClientChannel.NullIoInputStream

Modifier and Type	Field and Description
protected ChannelAsyncInputStream	asyncErr
protected ChannelAsyncOutputStream	asyncIn
protected ChannelAsyncInputStream	asyncOut
private final String	channelType
protected OutputStream	err
protected final AtomicReference<String>	exitSignalHolder
protected final AtomicReference<Integer>	exitStatusHolder
protected InputStream	in
protected InputStream	invertedErr
protected OutputStream	invertedIn
protected InputStream	invertedOut
private static final InputStream	NULL_INPUT_STREAM
protected final AtomicBoolean	opened
protected String	openFailureLang
protected String	openFailureMsg
protected int	openFailureReason
protected OpenFuture	openFuture
protected OutputStream	out
protected boolean	redirectErrorStream
protected StreamingChannel.Streaming	streaming

Constructor Summary

Access	Constructor and Description
protected	AbstractClientChannel(String type)
protected	AbstractClientChannel(String type, Collection<? extends RequestHandler<Channel>> handlers)

Method Summary

Modifier and Type	Method and Description
protected void	addChannelSignalRequestHandlers(EventNotifier<String> notifier)
protected abstract void	doOpen()
protected void	doWriteData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.
protected void	doWriteExtendedData(byte[] data, int off, long len) Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.
public IoInputStream	getAsyncErr() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr.
public IoOutputStream	getAsyncIn() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncIn.
public IoInputStream	getAsyncOut() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncOut.
public Set<ClientChannelEvent>	getChannelState() Implements org.apache.sshd.client.channel.ClientChannel.getChannelState.
public String	getChannelType() Implements org.apache.sshd.client.channel.ClientChannel.getChannelType.
public OutputStream	getErr()
public String	getExitSignal() Implements org.apache.sshd.client.channel.ClientChannel.getExitSignal.
public Integer	getExitStatus() Implements org.apache.sshd.client.channel.ClientChannel.getExitStatus.
public InputStream	getIn()
protected Closeable	getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.
public InputStream	getInvertedErr() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data directly from the channel.
public OutputStream	getInvertedIn() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedIn. Obtains an `OutputStream` to send data directly to the remote end of the channel.
public InputStream	getInvertedOut() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedOut. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_DATA` data directly from the channel.
public OutputStream	getOut()
public StreamingChannel.Streaming	getStreaming() Implements org.apache.sshd.common.channel.StreamingChannel.getStreaming.
public void	handleOpenFailure(Buffer Incoming `Buffer` that triggered the call Note the buffer's read position is exactly after the information that read to this call was decoded buffer) Implements org.apache.sshd.common.channel.Channel.handleOpenFailure. For a client channel, this method will be called internally by the session when the server has rejected this channel opening.
public void	handleOpenSuccess(long Recipient identifier (UINT32 represented as a `long`) recipient, long Read/Write window size (`uint32`) rwSize, long Preferred maximum packet size (`uint32`) packetSize, Buffer Incoming `Buffer` that triggered the call Note the buffer's read position is exactly after the information that read to this call was decoded buffer) Implements org.apache.sshd.common.channel.Channel.handleOpenSuccess. For a client channel, this method will be called internally by the session when the confirmation has been received.
public void	handleWindowAdjust(Buffer The rest of the message data `Buffer` after decoding the channel identifiers buffer) Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received
public boolean	isRedirectErrorStream()
protected boolean	mayWrite() Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.
public synchronized OpenFuture	open() Implements org.apache.sshd.client.channel.ClientChannel.open.
public OpenFuture	open(long Recipient identifier (UINT32 represented as a `long`) recipient, long Read/Write window size (`uint32`) rwSize, long Preferred maximum packet size (`uint32`) packetSize, Buffer Incoming `Buffer` that triggered the call Note the buffer's read position is exactly after the information that read to this call was decoded buffer) Implements org.apache.sshd.common.channel.Channel.open. For a server channel, this method will actually open the channel
public void	setErr(OutputStream the `OutputStream` err) Implements org.apache.sshd.client.channel.ClientChannel.setErr. Sets an output stream for the channel to write received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data to.
public void	setIn(InputStream an `InputStream` to be polled and forwarded in) Implements org.apache.sshd.client.channel.ClientChannel.setIn. Sets an `InputStream` that will be read by this channel and forwarded to the remote channel.
public void	setOut(OutputStream the `OutputStream` out) Implements org.apache.sshd.client.channel.ClientChannel.setOut. Sets an output stream for the channel to write received `SshConstants#SSH_MSG_CHANNEL_DATA` data to.
public void	setRedirectErrorStream(boolean whether to redirect the error stream to the output stream. redirectErrorStream) Implements org.apache.sshd.client.channel.ClientChannel.setRedirectErrorStream. Defines whether to redirect the error stream into the output stream; has no effect if `setErr(OutputStream)` has also been called by the time the channel is opened.
public void	setStreaming(StreamingChannel.Streaming streaming) Implements org.apache.sshd.common.channel.StreamingChannel.setStreaming.
protected <C extends Collection<ClientChannelEvent>> C	updateCurrentChannelState(C state)
public Set<ClientChannelEvent>	waitFor(Collection<ClientChannelEvent> The `ClientChannelEvent`s mask mask, long The timeout to wait (msec.) - if non-positive then forever timeout) Implements org.apache.sshd.client.channel.ClientChannel.waitFor. Waits until any of the specified events in the mask is signaled

Inherited from org.apache.sshd.common.channel.AbstractChannel:: addChannelListener addPendingRequest addRequestHandler attributeKeys clearAttributes computeAttributeIfAbsent configureWindow getAttribute getAttributesCount getChannelId getChannelListenerProxy getChannelStreamWriterResolver getExecutorService getLocalWindow getPacketValidator getParentPropertyResolver getProperties getRecipient getRemoteWindow getRequestHandlers getSession handleChannelRegistrationResult handleChannelRequest handleChannelUnregistration handleClose handleData handleEof handleExtendedData handleFailure handleInternalRequest handleRequest handleSuccess handleUnknownChannelRequest init invokeChannelSignaller isEofSent isEofSignalled isInitialized notifyStateChanged notifyStateChanged preClose removeAttribute removeChannelListener removePendingRequest removeRequestHandler resolveChannelStreamWriterResolver sendEof sendResponse sendWindowAdjust setAttribute setChannelStreamWriterResolver setPacketValidator setRecipient signalChannelClosed signalChannelClosed signalChannelInitialized signalChannelInitialized signalChannelOpenFailure signalChannelOpenFailure signalChannelOpenSuccess signalChannelOpenSuccess toString validateIncomingDataSize writePacket

Field Detail

asyncErr	back to summary
protected ChannelAsyncInputStream asyncErr

asyncIn	back to summary
protected ChannelAsyncOutputStream asyncIn

asyncOut	back to summary
protected ChannelAsyncInputStream asyncOut

channelType	back to summary
private final String channelType

err	back to summary
protected OutputStream err

exitSignalHolder	back to summary
protected final AtomicReference<String> exitSignalHolder

exitStatusHolder	back to summary
protected final AtomicReference<Integer> exitStatusHolder

in	back to summary
protected InputStream in

invertedErr	back to summary
protected InputStream invertedErr

invertedIn	back to summary
protected OutputStream invertedIn

invertedOut	back to summary
protected InputStream invertedOut

NULL_INPUT_STREAM	back to summary
private static final InputStream NULL_INPUT_STREAM

opened	back to summary
protected final AtomicBoolean opened

openFailureLang	back to summary
protected String openFailureLang

openFailureMsg	back to summary
protected String openFailureMsg

openFailureReason	back to summary
protected int openFailureReason

openFuture	back to summary
protected OpenFuture openFuture

out	back to summary
protected OutputStream out

redirectErrorStream	back to summary
protected boolean redirectErrorStream

streaming	back to summary
protected StreamingChannel.Streaming streaming

Constructor Detail

AbstractClientChannel	back to summary
protected AbstractClientChannel(String type)

AbstractClientChannel	back to summary
protected AbstractClientChannel(String type, Collection<? extends RequestHandler<Channel>> handlers)

Method Detail

addChannelSignalRequestHandlers	back to summary
protected void addChannelSignalRequestHandlers(EventNotifier<String> notifier)

doOpen	back to summary
protected abstract void doOpen() throws IOException

doWriteData	back to summary
protected void doWriteData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData. Annotations @Override

doWriteData

back to summary

protected void doWriteData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteData.

Annotations

@Override

doWriteExtendedData	back to summary
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData. Annotations @Override

doWriteExtendedData

back to summary

protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException

Implements abstract org.apache.sshd.common.channel.AbstractChannel.doWriteExtendedData.

Annotations

@Override

getAsyncErr	back to summary
public IoInputStream getAsyncErr() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr. Annotations @Override

getAsyncErr

back to summary

public IoInputStream getAsyncErr()

Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr.

Annotations

@Override

getAsyncIn	back to summary
public IoOutputStream getAsyncIn() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncIn. Annotations @Override

getAsyncIn

back to summary

public IoOutputStream getAsyncIn()

Implements org.apache.sshd.client.channel.ClientChannel.getAsyncIn.

Annotations

@Override

getAsyncOut	back to summary
public IoInputStream getAsyncOut() Implements org.apache.sshd.client.channel.ClientChannel.getAsyncOut. Annotations @Override

getAsyncOut

back to summary

public IoInputStream getAsyncOut()

Implements org.apache.sshd.client.channel.ClientChannel.getAsyncOut.

Annotations

@Override

getChannelState	back to summary
public Set<ClientChannelEvent> getChannelState() Implements org.apache.sshd.client.channel.ClientChannel.getChannelState. Returns:Set<ClientChannelEvent> Doc from org.apache.sshd.client.channel.ClientChannel.getChannelState. A snapshot of the current channel state Annotations @Override

getChannelState

back to summary

public Set<ClientChannelEvent> getChannelState()

Implements org.apache.sshd.client.channel.ClientChannel.getChannelState.

Returns:Set<ClientChannelEvent>

Doc from org.apache.sshd.client.channel.ClientChannel.getChannelState.

A snapshot of the current channel state

Annotations

@Override

getChannelType	back to summary
public String getChannelType() Implements org.apache.sshd.client.channel.ClientChannel.getChannelType. Returns:String Doc from org.apache.sshd.client.channel.ClientChannel.getChannelType. The type of channel reported when it was created Annotations @Override

getChannelType

back to summary

public String getChannelType()

Implements org.apache.sshd.client.channel.ClientChannel.getChannelType.

Returns:String

Doc from org.apache.sshd.client.channel.ClientChannel.getChannelType.

The type of channel reported when it was created

Annotations

@Override

getErr	back to summary
public OutputStream getErr()

getExitSignal back to summary

getExitSignal	back to summary
public String getExitSignal() Implements org.apache.sshd.client.channel.ClientChannel.getExitSignal. Returns:String Doc from org.apache.sshd.client.channel.ClientChannel.getExitSignal. The signaled exit signal via "exit-signal" - `null` if not signaled Annotations @Override

public String getExitSignal()

Implements org.apache.sshd.client.channel.ClientChannel.getExitSignal.

Returns:String

Doc from org.apache.sshd.client.channel.ClientChannel.getExitSignal.

The signaled exit signal via "exit-signal" - null if not signaled

Annotations

@Override

getExitStatus back to summary

getExitStatus	back to summary
public Integer getExitStatus() Implements org.apache.sshd.client.channel.ClientChannel.getExitStatus. Returns:Integer Doc from org.apache.sshd.client.channel.ClientChannel.getExitStatus. The signaled exit status via "exit-status" request - `null` if not signaled Annotations @Override

public Integer getExitStatus()

Implements org.apache.sshd.client.channel.ClientChannel.getExitStatus.

Returns:Integer

Doc from org.apache.sshd.client.channel.ClientChannel.getExitStatus.

The signaled exit status via "exit-status" request - null if not signaled

Annotations

@Override

getIn	back to summary
public InputStream getIn()

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Overrides org.apache.sshd.common.channel.AbstractChannel.getInnerCloseable.

Annotations

@Override

getInvertedErr back to summary

getInvertedErr	back to summary
public InputStream getInvertedErr() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data directly from the channel. This is an alternative to `setErr(OutputStream)`. If the error stream is redirected to the output stream via `setRedirectErrorStream(true)`, the returned stream will not receive any data and be always at EOF. When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards. As with all external processes, the application should read this stream (unless it was redirected) to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted. This method should be called only after the channel has been opened. Returns:InputStream an `InputStream` for reading received data, or `null` if an output stream was set via `setErr(OutputStream)` Annotations @Override

public InputStream getInvertedErr()

Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr.

Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedErr.

Obtains an InputStream to read received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data directly from the channel. This is an alternative to setErr(OutputStream). If the error stream is redirected to the output stream via setRedirectErrorStream(true), the returned stream will not receive any data and be always at EOF.

When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards.

As with all external processes, the application should read this stream (unless it was redirected) to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted.

This method should be called only after the channel has been opened.

Returns:InputStream

an InputStream for reading received data, or null if an output stream was set via setErr(OutputStream)

Annotations

@Override

getInvertedIn back to summary

getInvertedIn	back to summary
public OutputStream getInvertedIn() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedIn. Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedIn. Obtains an `OutputStream` to send data directly to the remote end of the channel. This can be used instead of using `setIn(InputStream)` method and having the channel polling for data in that stream. When the channel closes, it will `close` the returned stream. This method should be called only after the channel has been opened. Returns:OutputStream an `OutputStream` for sending data, or `null` if an input stream was set via `setIn(InputStream)` Annotations @Override

public OutputStream getInvertedIn()

Implements org.apache.sshd.client.channel.ClientChannel.getInvertedIn.

Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedIn.

Obtains an OutputStream to send data directly to the remote end of the channel. This can be used instead of using setIn(InputStream) method and having the channel polling for data in that stream.

When the channel closes, it will close the returned stream.

This method should be called only after the channel has been opened.

Returns:OutputStream

an OutputStream for sending data, or null if an input stream was set via setIn(InputStream)

Annotations

@Override

getInvertedOut back to summary

getInvertedOut	back to summary
public InputStream getInvertedOut() Implements org.apache.sshd.client.channel.ClientChannel.getInvertedOut. Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedOut. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_DATA` data directly from the channel. This is an alternative to `setOut(OutputStream)`. If the error stream is redirected to the output stream via `setRedirectErrorStream(true)`, this stream will also receive `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data. When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards. As with all external processes, the application should read this stream to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted. This method should be called only after the channel has been opened. Returns:InputStream an `InputStream` for reading received data, or `null` if an output stream was set via `setOut(OutputStream)` Annotations @Override

public InputStream getInvertedOut()

Implements org.apache.sshd.client.channel.ClientChannel.getInvertedOut.

Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedOut.

Obtains an InputStream to read received SshConstants#SSH_MSG_CHANNEL_DATA data directly from the channel. This is an alternative to setOut(OutputStream). If the error stream is redirected to the output stream via setRedirectErrorStream(true), this stream will also receive SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data.

As with all external processes, the application should read this stream to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted.

This method should be called only after the channel has been opened.

Returns:InputStream

an InputStream for reading received data, or null if an output stream was set via setOut(OutputStream)

Annotations

@Override

getOut	back to summary
public OutputStream getOut()

getStreaming	back to summary
public StreamingChannel.Streaming getStreaming() Implements org.apache.sshd.common.channel.StreamingChannel.getStreaming. Annotations @Override

getStreaming

back to summary

public StreamingChannel.Streaming getStreaming()

Implements org.apache.sshd.common.channel.StreamingChannel.getStreaming.

Annotations

@Override

handleOpenFailure back to summary

handleOpenFailure	back to summary
public void handleOpenFailure(Buffer buffer) Implements org.apache.sshd.common.channel.Channel.handleOpenFailure. Doc from org.apache.sshd.common.channel.Channel.handleOpenFailure. For a client channel, this method will be called internally by the session when the server has rejected this channel opening. Parameters buffer:Buffer Incoming `Buffer` that triggered the call Note the buffer's read position is exactly after the information that read to this call was decoded Annotations @Override

public void handleOpenFailure(Buffer buffer)

Implements org.apache.sshd.common.channel.Channel.handleOpenFailure.

Doc from org.apache.sshd.common.channel.Channel.handleOpenFailure.

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Parameters

buffer:Buffer: Incoming Buffer that triggered the call
Note
the buffer's read position is exactly after the information that read to this call was decoded

Annotations

@Override

handleOpenSuccess back to summary

handleOpenSuccess	back to summary
public void handleOpenSuccess(long recipient, long rwSize, long packetSize, Buffer buffer) Implements org.apache.sshd.common.channel.Channel.handleOpenSuccess. Doc from org.apache.sshd.common.channel.Channel.handleOpenSuccess. For a client channel, this method will be called internally by the session when the confirmation has been received. Parameters recipient:long Recipient identifier (UINT32 represented as a `long`) rwSize:long Read/Write window size (`uint32`) packetSize:long Preferred maximum packet size (`uint32`) buffer:Buffer Incoming `Buffer` that triggered the call Note the buffer's read position is exactly after the information that read to this call was decoded Annotations @Override

public void handleOpenSuccess(long recipient, long rwSize, long packetSize, Buffer buffer)

Implements org.apache.sshd.common.channel.Channel.handleOpenSuccess.

Doc from org.apache.sshd.common.channel.Channel.handleOpenSuccess.

For a client channel, this method will be called internally by the session when the confirmation has been received.

Parameters

recipient:long: Recipient identifier (UINT32 represented as a long)
rwSize:long: Read/Write window size (uint32)
packetSize:long: Preferred maximum packet size (uint32)
buffer:Buffer: Incoming Buffer that triggered the call
Note
the buffer's read position is exactly after the information that read to this call was decoded

Annotations

@Override

handleWindowAdjust back to summary

handleWindowAdjust	back to summary
public void handleWindowAdjust(Buffer buffer) throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust. Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust. Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust. Invoked when `SSH_MSG_CHANNEL_WINDOW_ADJUST` received Parameters buffer:Buffer The rest of the message data `Buffer` after decoding the channel identifiers Annotations @Override Exceptions IOException: If failed to handle the message

public void handleWindowAdjust(Buffer buffer) throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleWindowAdjust.

Implements org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Doc from org.apache.sshd.common.channel.Channel.handleWindowAdjust.

Invoked when SSH_MSG_CHANNEL_WINDOW_ADJUST received

Parameters

buffer:Buffer: The rest of the message data Buffer after decoding the channel identifiers

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

isRedirectErrorStream	back to summary
public boolean isRedirectErrorStream()

mayWrite	back to summary
protected boolean mayWrite() Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite. Annotations @Override

mayWrite

back to summary

protected boolean mayWrite()

Overrides org.apache.sshd.common.channel.AbstractChannel.mayWrite.

Annotations

@Override

open

back to summary

public synchronized OpenFuture open() throws IOException

Implements org.apache.sshd.client.channel.ClientChannel.open.

Annotations

@Override

open back to summary

public OpenFuture open(long recipient, long rwSize, long packetSize, Buffer buffer)

Implements org.apache.sshd.common.channel.Channel.open.

Doc from org.apache.sshd.common.channel.Channel.open.

For a server channel, this method will actually open the channel

Parameters

recipient:long: Recipient identifier (UINT32 represented as a long)
rwSize:long: Read/Write window size (uint32)
packetSize:long: Preferred maximum packet size (uint32)
buffer:Buffer: Incoming Buffer that triggered the call
Note
the buffer's read position is exactly after the information that read to this call was decoded

Returns:OpenFuture

An OpenFuture for the channel open request

Annotations

@Override

setErr back to summary

public void setErr(OutputStream err)

Implements org.apache.sshd.client.channel.ClientChannel.setErr.

Doc from org.apache.sshd.client.channel.ClientChannel.setErr.

Sets an output stream for the channel to write received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data to. For remote command execution, this is typically the remote command's stderr.

The stream must be set before the channel is opened. When the channel closes, it will close the given stream.

If no stream is set by the time the channel is opened, the channel will internally forward data to a stream that can be read via the InputStream obtained via getInvertedErr(). (Or it might forward the data to the output stream if setRedirectErrorStream(true) is set.)

Parameters

err:OutputStream: the OutputStream

Annotations

@Override

setIn back to summary

public void setIn(InputStream in)

Implements org.apache.sshd.client.channel.ClientChannel.setIn.

Doc from org.apache.sshd.client.channel.ClientChannel.setIn.

Sets an InputStream that will be read by this channel and forwarded to the remote channel. Note that using such a stream will create an additional thread for pumping the stream which will only be able to end when that stream is actually closed or EOF on the stream is reached. It is recommended to use the getInvertedIn() method instead and write data directly.

The stream must be set before the channel is opened. When the channel closes, it will close the given stream. If the stream should not be closed (for instance, if it is System.in), wrap it in an NoCloseInputStream.

Parameters

in:InputStream: an InputStream to be polled and forwarded

Annotations

@Override

setOut back to summary

public void setOut(OutputStream out)

Implements org.apache.sshd.client.channel.ClientChannel.setOut.

Doc from org.apache.sshd.client.channel.ClientChannel.setOut.

Sets an output stream for the channel to write received SshConstants#SSH_MSG_CHANNEL_DATA data to. For remote command execution, this is typically the remote command's stdout. If the error stream is redirected to the output stream via setRedirectErrorStream(true), this stream will also receive SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data.

The stream must be set before the channel is opened. When the channel closes, it will close the given stream.

If no stream is set by the time the channel is opened, the channel will internally forward data to a stream that can be read via the InputStream obtained via getInvertedOut().

Parameters

out:OutputStream: the OutputStream

Annotations

@Override

setRedirectErrorStream back to summary

public void setRedirectErrorStream(boolean redirectErrorStream)

Implements org.apache.sshd.client.channel.ClientChannel.setRedirectErrorStream.

Doc from org.apache.sshd.client.channel.ClientChannel.setRedirectErrorStream.

Defines whether to redirect the error stream into the output stream; has no effect if setErr(OutputStream) has also been called by the time the channel is opened.

Parameters

redirectErrorStream:boolean: whether to redirect the error stream to the output stream.

Annotations

@Override

setStreaming

back to summary

public void setStreaming(StreamingChannel.Streaming streaming)

Implements org.apache.sshd.common.channel.StreamingChannel.setStreaming.

Annotations

@Override

updateCurrentChannelState	back to summary
protected <C extends Collection<ClientChannelEvent>> C updateCurrentChannelState(C state)

waitFor back to summary

public Set<ClientChannelEvent> waitFor(Collection<ClientChannelEvent> mask, long timeout)

Implements org.apache.sshd.client.channel.ClientChannel.waitFor.

Doc from org.apache.sshd.client.channel.ClientChannel.waitFor.

Waits until any of the specified events in the mask is signaled

Parameters

mask:Collection<ClientChannelEvent>: The ClientChannelEvents mask
timeout:long: The timeout to wait (msec.) - if non-positive then forever

Returns:Set<ClientChannelEvent>

The actual signaled event - includes ClientChannelEvent#TIMEOUT if timeout expired before the expected event was signaled

Annotations

@Override

Field Summary

Modifier and Type	Field and Description
private final CloseFuture	closing
public static final AbstractClientChannel.NullIoInputStream	INSTANCE

Method Summary

Modifier and Type	Method and Description
public void	addCloseFutureListener(SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null` listener) Implements org.apache.sshd.common.Closeable.addCloseFutureListener. Pre-register a listener to be informed when resource is closed.
public CloseFuture	close(boolean `true` if the resource should be shut down abruptly, `false` for a graceful close immediately) Implements org.apache.sshd.common.Closeable.close. Close this resource asynchronously and return a future.
public boolean	isClosed() Implements org.apache.sshd.common.Closeable.isClosed. Returns `true` if this object has been closed.
public boolean	isClosing() Implements org.apache.sshd.common.Closeable.isClosing. Returns `true` if the `close(boolean)` method has been called.
public IoReadFuture	read(Buffer the `Buffer` to use buffer) Implements org.apache.sshd.common.io.IoInputStream.read. Note the buffer must not be touched until the returned read future is completed.
public void	removeCloseFutureListener(SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed listener) Implements org.apache.sshd.common.Closeable.removeCloseFutureListener. Remove a pre-registered close event listener
public static AbstractClientChannel.NullIoInputStream	valueOf(String name)
public static AbstractClientChannel.NullIoInputStream[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

closing	back to summary
private final CloseFuture closing

INSTANCE	back to summary
public static final AbstractClientChannel.NullIoInputStream INSTANCE

Constructor Detail

NullIoInputStream	back to summary
private NullIoInputStream()

Method Detail

addCloseFutureListener back to summary

public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.addCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.addCloseFutureListener.

Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification

Parameters

listener:SshFutureListener<CloseFuture>: The notification SshFutureListener - never null

Annotations

@Override

close back to summary

public CloseFuture close(boolean immediately)

Implements org.apache.sshd.common.Closeable.close.

Doc from org.apache.sshd.common.Closeable.close.

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Parameters