Class AbstractClientChannel
- java.lang.Object
-
- org.apache.sshd.common.util.logging.AbstractLoggingBean
-
- org.apache.sshd.common.util.closeable.IoBaseCloseable
-
- org.apache.sshd.common.util.closeable.AbstractCloseable
-
- org.apache.sshd.common.util.closeable.AbstractInnerCloseable
-
- org.apache.sshd.common.channel.AbstractChannel
-
- org.apache.sshd.client.channel.AbstractClientChannel
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Channel,ClientChannel,ClientSessionHolder,AttributeRepository,AttributeStore,Channel,ChannelIdentifier,ChannelListenerManager,StreamingChannel,ChannelStreamWriterResolver,ChannelStreamWriterResolverManager,Closeable,PropertyResolver,SessionContextHolder,SessionHolder<Session>,ExecutorServiceCarrier
- Direct Known Subclasses:
AgentForwardedChannel,AgentForwardedChannel,ChannelDirectTcpip,ChannelForwardedX11,ChannelSession,TcpipClientChannel
public abstract class AbstractClientChannel extends AbstractChannel implements ClientChannel
TODO Add javadoc- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.sshd.common.channel.AbstractChannel
AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState, AbstractChannel.PacketValidator
-
Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
AbstractCloseable.State
-
Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository
AttributeRepository.AttributeKey<T extends Object>
-
Nested classes/interfaces inherited from interface org.apache.sshd.common.channel.StreamingChannel
StreamingChannel.Streaming
-
-
Field Summary
Fields Modifier and Type Field Description protected ChannelAsyncInputStreamasyncErrprotected ChannelAsyncOutputStreamasyncInprotected ChannelAsyncInputStreamasyncOutprotected OutputStreamerrprotected AtomicReference<String>exitSignalHolderprotected AtomicReference<Integer>exitStatusHolderprotected InputStreaminprotected InputStreaminvertedErrprotected OutputStreaminvertedInprotected InputStreaminvertedOutprotected AtomicBooleanopenedprotected StringopenFailureLangprotected StringopenFailureMsgprotected intopenFailureReasonprotected OpenFutureopenFutureprotected OutputStreamoutprotected booleanredirectErrorStreamprotected StreamingChannel.Streamingstreaming-
Fields inherited from class org.apache.sshd.common.channel.AbstractChannel
channelListenerProxy, channelListeners, closeSignaled, DEFAULT_PACKET_VALIDATOR, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service, unregisterSignaled
-
Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
closeFuture, futureLock, state
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Fields inherited from interface org.apache.sshd.common.channel.Channel
CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM
-
Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver
NONE
-
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractClientChannel(String type)protectedAbstractClientChannel(String type, Collection<? extends RequestHandler<Channel>> handlers)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidaddChannelSignalRequestHandlers(EventNotifier<String> notifier)protected abstract voiddoOpen()protected voiddoWriteData(byte[] data, int off, long len)protected voiddoWriteExtendedData(byte[] data, int off, long len)IoInputStreamgetAsyncErr()IoOutputStreamgetAsyncIn()IoInputStreamgetAsyncOut()Set<ClientChannelEvent>getChannelState()StringgetChannelType()OutputStreamgetErr()StringgetExitSignal()IntegergetExitStatus()InputStreamgetIn()protected CloseablegetInnerCloseable()InputStreamgetInvertedErr()Obtains anInputStreamto read receivedSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata directly from the channel.OutputStreamgetInvertedIn()Obtains anOutputStreamto send data directly to the remote end of the channel.InputStreamgetInvertedOut()Obtains anInputStreamto read receivedSshConstants.SSH_MSG_CHANNEL_DATAdata directly from the channel.OutputStreamgetOut()StreamingChannel.StreaminggetStreaming()voidhandleOpenFailure(Buffer buffer)For a client channel, this method will be called internally by the session when the server has rejected this channel opening.voidhandleOpenSuccess(long recipient, long rwSize, long packetSize, Buffer buffer)For a client channel, this method will be called internally by the session when the confirmation has been received.voidhandleWindowAdjust(Buffer buffer)Invoked whenSSH_MSG_CHANNEL_WINDOW_ADJUSTreceivedbooleanisRedirectErrorStream()protected booleanmayWrite()OpenFutureopen()OpenFutureopen(long recipient, long rwSize, long packetSize, Buffer buffer)For a server channel, this method will actually open the channelvoidsetErr(OutputStream err)Sets an output stream for the channel to write receivedSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata to.voidsetIn(InputStream in)Sets anInputStreamthat will be read by this channel and forwarded to the remote channel.voidsetOut(OutputStream out)Sets an output stream for the channel to write receivedSshConstants.SSH_MSG_CHANNEL_DATAdata to.voidsetRedirectErrorStream(boolean redirectErrorStream)Defines whether to redirect the error stream into the output stream; has no effect ifClientChannel.setErr(OutputStream)has also been called by the time the channel is opened.voidsetStreaming(StreamingChannel.Streaming streaming)protected <C extends Collection<ClientChannelEvent>>
CupdateCurrentChannelState(C state)Set<ClientChannelEvent>waitFor(Collection<ClientChannelEvent> mask, long timeout)Waits until any of the specified events in the mask is signaled-
Methods inherited from class 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
-
Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable
doCloseGracefully, doCloseImmediately
-
Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener
-
Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.sshd.common.AttributeRepository
attributeKeys, getAttribute, getAttributesCount
-
Methods inherited from interface org.apache.sshd.common.AttributeStore
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute
-
Methods inherited from interface org.apache.sshd.common.channel.Channel
addRequestHandler, addRequestHandlers, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, handleChannelRegistrationResult, handleChannelUnregistration, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, handleSuccess, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute, writePacket
-
Methods inherited from interface org.apache.sshd.common.channel.ChannelIdentifier
getChannelId
-
Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListener
-
Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager
getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver
-
Methods inherited from interface org.apache.sshd.client.channel.ClientChannel
getClientSession, waitFor
-
Methods inherited from interface org.apache.sshd.common.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener
-
Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty, isEmpty
-
Methods inherited from interface org.apache.sshd.common.session.SessionHolder
getSession, getSessionContext
-
-
-
-
Field Detail
-
opened
protected final AtomicBoolean opened
-
streaming
protected StreamingChannel.Streaming streaming
-
asyncIn
protected ChannelAsyncOutputStream asyncIn
-
asyncOut
protected ChannelAsyncInputStream asyncOut
-
asyncErr
protected ChannelAsyncInputStream asyncErr
-
in
protected InputStream in
-
invertedIn
protected OutputStream invertedIn
-
out
protected OutputStream out
-
invertedOut
protected InputStream invertedOut
-
err
protected OutputStream err
-
invertedErr
protected InputStream invertedErr
-
redirectErrorStream
protected boolean redirectErrorStream
-
exitStatusHolder
protected final AtomicReference<Integer> exitStatusHolder
-
exitSignalHolder
protected final AtomicReference<String> exitSignalHolder
-
openFailureReason
protected int openFailureReason
-
openFailureMsg
protected String openFailureMsg
-
openFailureLang
protected String openFailureLang
-
openFuture
protected OpenFuture openFuture
-
-
Constructor Detail
-
AbstractClientChannel
protected AbstractClientChannel(String type)
-
AbstractClientChannel
protected AbstractClientChannel(String type, Collection<? extends RequestHandler<Channel>> handlers)
-
-
Method Detail
-
addChannelSignalRequestHandlers
protected void addChannelSignalRequestHandlers(EventNotifier<String> notifier)
-
getChannelType
public String getChannelType()
- Specified by:
getChannelTypein interfaceClientChannel- Returns:
- The type of channel reported when it was created
-
getStreaming
public StreamingChannel.Streaming getStreaming()
- Specified by:
getStreamingin interfaceStreamingChannel
-
setStreaming
public void setStreaming(StreamingChannel.Streaming streaming)
- Specified by:
setStreamingin interfaceStreamingChannel
-
getAsyncIn
public IoOutputStream getAsyncIn()
- Specified by:
getAsyncInin interfaceClientChannel
-
getAsyncOut
public IoInputStream getAsyncOut()
- Specified by:
getAsyncOutin interfaceClientChannel
-
getAsyncErr
public IoInputStream getAsyncErr()
- Specified by:
getAsyncErrin interfaceClientChannel
-
getInvertedIn
public OutputStream getInvertedIn()
Description copied from interface:ClientChannelObtains anOutputStreamto send data directly to the remote end of the channel. This can be used instead of usingClientChannel.setIn(InputStream)method and having the channel polling for data in that stream.When the channel closes, it will
closethe returned stream.This method should be called only after the channel has been opened.
- Specified by:
getInvertedInin interfaceClientChannel- Returns:
- an
OutputStreamfor sending data, ornullif an input stream was set viaClientChannel.setIn(InputStream) - See Also:
ClientChannel.setIn(InputStream)
-
getIn
public InputStream getIn()
-
setIn
public void setIn(InputStream in)
Description copied from interface:ClientChannelSets anInputStreamthat 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 theClientChannel.getInvertedIn()method instead and write data directly.The stream must be set before the channel is opened. When the channel closes, it will
closethe given stream.- Specified by:
setInin interfaceClientChannel- Parameters:
in- anInputStreamto be polled and forwarded- See Also:
ClientChannel.getInvertedIn()
-
getInvertedOut
public InputStream getInvertedOut()
Description copied from interface:ClientChannelObtains anInputStreamto read receivedSshConstants.SSH_MSG_CHANNEL_DATAdata directly from the channel. This is an alternative toClientChannel.setOut(OutputStream). If the error stream is redirected to the output stream viasetRedirectErrorStream(true), this stream will also receiveSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata.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.
- Specified by:
getInvertedOutin interfaceClientChannel- Returns:
- an
InputStreamfor reading received data, ornullif an output stream was set viaClientChannel.setOut(OutputStream) - See Also:
ClientChannel.setOut(OutputStream),ClientChannel.setRedirectErrorStream(boolean)
-
getOut
public OutputStream getOut()
-
setOut
public void setOut(OutputStream out)
Description copied from interface:ClientChannelSets an output stream for the channel to write receivedSshConstants.SSH_MSG_CHANNEL_DATAdata to. For remote command execution, this is typically the remote command'sstdout. If the error stream is redirected to the output stream viasetRedirectErrorStream(true), this stream will also receiveSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata.The stream must be set before the channel is opened. When the channel closes, it will
closethe 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
InputStreamobtained viaClientChannel.getInvertedOut().- Specified by:
setOutin interfaceClientChannel- Parameters:
out- theOutputStream- See Also:
ClientChannel.getInvertedOut(),ClientChannel.setRedirectErrorStream(boolean)
-
getInvertedErr
public InputStream getInvertedErr()
Description copied from interface:ClientChannelObtains anInputStreamto read receivedSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata directly from the channel. This is an alternative toClientChannel.setErr(OutputStream). If the error stream is redirected to the output stream viasetRedirectErrorStream(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.
- Specified by:
getInvertedErrin interfaceClientChannel- Returns:
- an
InputStreamfor reading received data, ornullif an output stream was set viaClientChannel.setErr(OutputStream) - See Also:
ClientChannel.setErr(OutputStream),ClientChannel.setRedirectErrorStream(boolean)
-
getErr
public OutputStream getErr()
-
setErr
public void setErr(OutputStream err)
Description copied from interface:ClientChannelSets an output stream for the channel to write receivedSshConstants.SSH_MSG_CHANNEL_EXTENDED_DATAdata to. For remote command execution, this is typically the remote command'sstderr.The stream must be set before the channel is opened. When the channel closes, it will
closethe 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
InputStreamobtained viaClientChannel.getInvertedErr(). (Or it might forward the data to the output stream ifsetRedirectErrorStream(true)is set.)- Specified by:
setErrin interfaceClientChannel- Parameters:
err- theOutputStream- See Also:
ClientChannel.getInvertedErr(),ClientChannel.setRedirectErrorStream(boolean)
-
isRedirectErrorStream
public boolean isRedirectErrorStream()
-
setRedirectErrorStream
public void setRedirectErrorStream(boolean redirectErrorStream)
Description copied from interface:ClientChannelDefines whether to redirect the error stream into the output stream; has no effect ifClientChannel.setErr(OutputStream)has also been called by the time the channel is opened.- Specified by:
setRedirectErrorStreamin interfaceClientChannel- Parameters:
redirectErrorStream- whether to redirect the error stream to the output stream.
-
getInnerCloseable
protected Closeable getInnerCloseable()
- Overrides:
getInnerCloseablein classAbstractChannel
-
waitFor
public Set<ClientChannelEvent> waitFor(Collection<ClientChannelEvent> mask, long timeout)
Description copied from interface:ClientChannelWaits until any of the specified events in the mask is signaled- Specified by:
waitForin interfaceClientChannel- Parameters:
mask- TheClientChannelEvents masktimeout- The timeout to wait (msec.) - if non-positive then forever- Returns:
- The actual signaled event - includes
ClientChannelEvent.TIMEOUTif timeout expired before the expected event was signaled
-
getChannelState
public Set<ClientChannelEvent> getChannelState()
- Specified by:
getChannelStatein interfaceClientChannel- Returns:
- A snapshot of the current channel state
- See Also:
ClientChannel.waitFor(Collection, long)
-
updateCurrentChannelState
protected <C extends Collection<ClientChannelEvent>> C updateCurrentChannelState(C state)
-
open
public OpenFuture open() throws IOException
- Specified by:
openin interfaceClientChannel- Throws:
IOException
-
open
public OpenFuture open(long recipient, long rwSize, long packetSize, Buffer buffer)
Description copied from interface:ChannelFor a server channel, this method will actually open the channel- Specified by:
openin interfaceChannel- Parameters:
recipient- Recipient identifier (UINT32 represented as along)rwSize- Read/Write window size (uint32)packetSize- Preferred maximum packet size (uint32)buffer- IncomingBufferthat triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded- Returns:
- An
OpenFuturefor the channel open request
-
handleOpenSuccess
public void handleOpenSuccess(long recipient, long rwSize, long packetSize, Buffer buffer)Description copied from interface:ChannelFor a client channel, this method will be called internally by the session when the confirmation has been received.- Specified by:
handleOpenSuccessin interfaceChannel- Parameters:
recipient- Recipient identifier (UINT32 represented as along)rwSize- Read/Write window size (uint32)packetSize- Preferred maximum packet size (uint32)buffer- IncomingBufferthat triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded
-
doOpen
protected abstract void doOpen() throws IOException- Throws:
IOException
-
handleOpenFailure
public void handleOpenFailure(Buffer buffer)
Description copied from interface:ChannelFor a client channel, this method will be called internally by the session when the server has rejected this channel opening.- Specified by:
handleOpenFailurein interfaceChannel- Parameters:
buffer- IncomingBufferthat triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded
-
doWriteData
protected void doWriteData(byte[] data, int off, long len) throws IOException- Specified by:
doWriteDatain classAbstractChannel- Throws:
IOException
-
doWriteExtendedData
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException- Specified by:
doWriteExtendedDatain classAbstractChannel- Throws:
IOException
-
handleWindowAdjust
public void handleWindowAdjust(Buffer buffer) throws IOException
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_WINDOW_ADJUSTreceived- Specified by:
handleWindowAdjustin interfaceChannel- Overrides:
handleWindowAdjustin classAbstractChannel- Parameters:
buffer- The rest of the message dataBufferafter decoding the channel identifiers- Throws:
IOException- If failed to handle the message
-
mayWrite
protected boolean mayWrite()
- Overrides:
mayWritein classAbstractChannel
-
getExitStatus
public Integer getExitStatus()
- Specified by:
getExitStatusin interfaceClientChannel- Returns:
- The signaled exit status via "exit-status" request -
nullif not signaled
-
getExitSignal
public String getExitSignal()
- Specified by:
getExitSignalin interfaceClientChannel- Returns:
- The signaled exit signal via "exit-signal" -
nullif not signaled
-
-