Class AbstractChannel
- All Implemented Interfaces:
Closeable,AutoCloseable,Channel,AttributeRepository,AttributeStore,Channel,ChannelIdentifier,ChannelListenerManager,ChannelStreamWriterResolver,ChannelStreamWriterResolverManager,Closeable,PropertyResolver,SessionContextHolder,SessionHolder<Session>,ExecutorServiceCarrier
- Direct Known Subclasses:
AbstractClientChannel,AbstractServerChannel
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassprotected static enumstatic interfaceAAbstractChannel.PacketValidatorcan validate packet lengths.Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
AbstractCloseable.StateNested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository
AttributeRepository.AttributeKey<T> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Map<AttributeRepository.AttributeKey<?>, Object> protected final ChannelListenerprotected final Collection<ChannelListener> Channel events listenerprivate ChannelStreamWriterResolverprotected final AtomicBooleanstatic final AbstractChannel.PacketValidatorA defaultAbstractChannel.PacketValidatorthat enforces that the packet size is not greater than the maximum packet size of the channel's local window.private AtomicReference<IoWriteFuture> protected final AtomicBooleanprotected final AtomicBooleanDeprecated.since 2.10.1private CloseableExecutorServiceprotected final DefaultCloseFutureprotected AtomicReference<AbstractChannel.GracefulState> private longprotected final AtomicBooleanprivate final LocalWindowprivate AbstractChannel.PacketValidatorAMapof sent requests - key = request name, value = timestamp when request was sent.private longprivate final RemoteWindowprivate final List<RequestHandler<Channel>> static final IntUnaryOperatorDefault growth factor function used to resize response buffersprotected ConnectionServiceprivate Sessionprotected final AtomicBooleanFields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
closeFuture, futureLock, stateFields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
logFields inherited from interface org.apache.sshd.common.channel.Channel
CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEMFields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver
NONEFields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractChannel(boolean client) protectedAbstractChannel(boolean client, Collection<? extends RequestHandler<Channel>> handlers) protectedAbstractChannel(String discriminator, boolean client) protectedAbstractChannel(String discriminator, boolean client, Collection<? extends RequestHandler<Channel>> handlers, CloseableExecutorService executorService) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddChannelListener(ChannelListener listener) Add a channel listenerprotected DateaddPendingRequest(String request, boolean wantReply) Add a channel request to the tracked pending ones if reply is expectedvoidaddRequestHandler(RequestHandler<Channel> handler) voidRemoves all currently stored user-defined attributes<T> TcomputeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key, Function<? super AttributeRepository.AttributeKey<T>, ? extends T> resolver) If the specified key is not already associated with a value (or is mapped tonull), attempts to compute its value using the given mapping function and enters it into this map unlessnull.protected voidprotected abstract voiddoWriteData(byte[] data, int off, long len) protected abstract voiddoWriteExtendedData(byte[] data, int off, long len) <T> TReturns the value of the user-defined attribute.intlongprotected CloseableRetrieves the currently setAbstractChannel.PacketValidator.A map of properties that can be used to configure the SSH server or client.longvoidhandleChannelRegistrationResult(ConnectionService service, Session session, long channelId, boolean registered) Invoked after being successfully registered by the connection service - should throw aRuntimeExceptionif not registeredprotected voidhandleChannelRequest(String req, boolean wantReply, Buffer buffer) voidCalled by the connection service to inform the channel that it has bee unregistered.voidInvoked whenSSH_MSG_CHANNEL_CLOSEreceivedvoidhandleData(Buffer buffer) Invoked whenSSH_MSG_CHANNEL_DATAreceivedvoidInvoked whenSSH_MSG_CHANNEL_EOFreceivedvoidhandleExtendedData(Buffer buffer) Invoked whenSSH_MSG_CHANNEL_EXTENDED_DATAreceivedvoidInvoked whenSSH_MSG_CHANNEL_FAILUREreceivedprotected RequestHandler.ResulthandleInternalRequest(String req, boolean wantReply, Buffer buffer) Called byhandleUnknownChannelRequest(String, boolean, Buffer)in order to allow channel request handling if none of the registered handlers processed the request - last chance.voidhandleRequest(Buffer buffer) Invoked whenSSH_MSG_CHANNEL_REQUESTreceivedvoidInvoked whenSSH_MSG_CHANNEL_SUCCESSreceivedprotected voidhandleUnknownChannelRequest(String req, boolean wantReply, Buffer buffer) Called when none of the register request handlers reported handling the requestvoidhandleWindowAdjust(Buffer buffer) Invoked whenSSH_MSG_CHANNEL_WINDOW_ADJUSTreceivedvoidinit(ConnectionService service, Session session, long id) Invoked when the local channel is initial createdprotected voidinvokeChannelSignaller(Invoker<ChannelListener, Void> invoker) booleanbooleanbooleanprotected booleanmayWrite()protected voidnotifyStateChanged(String hint) protected voidnotifyStateChanged(ChannelListener listener, String hint) protected voidpreClose()preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.<T> TRemoves the user-defined attributevoidremoveChannelListener(ChannelListener listener) Remove a channel listenerprotected DateremovePendingRequest(String request) Removes a channel request from the tracked onesvoidremoveRequestHandler(RequestHandler<Channel> handler) protected IoWriteFuturesendEof()SendsSSH_MSG_CHANNEL_EOFprovided not already sent and current channel state allows it.protected IoWriteFuturesendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply) protected voidsendWindowAdjust(long len) <T> TsetAttribute(AttributeRepository.AttributeKey<T> key, T value) Sets a user-defined attribute.voidvoidSets aAbstractChannel.PacketValidator.protected voidsetRecipient(long recipient) voidsignalChannelClosed(Throwable reason) protected voidsignalChannelClosed(ChannelListener listener, Throwable reason) protected voidprotected voidsignalChannelInitialized(ChannelListener listener) protected voidsignalChannelOpenFailure(Throwable reason) protected voidsignalChannelOpenFailure(ChannelListener listener, Throwable reason) protected voidprotected voidsignalChannelOpenSuccess(ChannelListener listener) toString()protected longvalidateIncomingDataSize(int cmd, long len) writePacket(Buffer buffer) Encode and send the given buffer.Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable
doCloseGracefully, doCloseImmediatelyMethods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListenerMethods 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, warnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.sshd.common.channel.Channel
addRequestHandlers, handleOpenFailure, handleOpenSuccess, open, removeRequestHandlers, resolveAttributeMethods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager
resolveChannelStreamWriterMethods inherited from interface org.apache.sshd.common.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListenerMethods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty, isEmptyMethods inherited from interface org.apache.sshd.common.session.SessionHolder
getSessionContext
-
Field Details
-
RESPONSE_BUFFER_GROWTH_FACTOR
Default growth factor function used to resize response buffers -
DEFAULT_PACKET_VALIDATOR
A defaultAbstractChannel.PacketValidatorthat enforces that the packet size is not greater than the maximum packet size of the channel's local window. -
service
-
initialized
-
eofReceived
-
eofSent
Deprecated.since 2.10.1Obsolete and unused; present only for API backwards compatibility. UseisEofSent()to determine whether EOF is already sent on this channel, andsendEof()to send EOF. The latter will returnnullif EOF already was sent. -
unregisterSignaled
-
closeSignaled
-
gracefulState
-
gracefulFuture
-
channelListeners
Channel events listener -
channelListenerProxy
-
id
private long id -
recipient
private long recipient -
sessionInstance
-
executor
-
requestHandlers
-
localWindow
-
remoteWindow
-
channelStreamPacketWriterResolver
-
eofFuture
-
packetValidator
-
pendingRequests
AMapof sent requests - key = request name, value = timestamp when request was sent. -
properties
-
attributes
-
-
Constructor Details
-
AbstractChannel
protected AbstractChannel(boolean client) -
AbstractChannel
-
AbstractChannel
-
AbstractChannel
protected AbstractChannel(String discriminator, boolean client, Collection<? extends RequestHandler<Channel>> handlers, CloseableExecutorService executorService)
-
-
Method Details
-
getRequestHandlers
- Specified by:
getRequestHandlersin interfaceChannel
-
addRequestHandler
- Specified by:
addRequestHandlerin interfaceChannel
-
removeRequestHandler
- Specified by:
removeRequestHandlerin interfaceChannel
-
getChannelId
public long getChannelId()- Specified by:
getChannelIdin interfaceChannelIdentifier- Returns:
- Local channel UINT32 identifier
-
getRecipient
public long getRecipient()- Specified by:
getRecipientin interfaceChannel- Returns:
- Remote channel UITN32 identifier
-
setRecipient
protected void setRecipient(long recipient) -
getLocalWindow
- Specified by:
getLocalWindowin interfaceChannel
-
getRemoteWindow
- Specified by:
getRemoteWindowin interfaceChannel
-
getSession
- Specified by:
getSessionin interfaceSessionHolder<Session>
-
getParentPropertyResolver
- Specified by:
getParentPropertyResolverin interfacePropertyResolver- Returns:
- The parent resolver that can be used to query for missing properties -
nullif no parent
-
getExecutorService
- Specified by:
getExecutorServicein interfaceExecutorServiceCarrier- Returns:
- The
CloseableExecutorServiceto use
-
getChannelStreamWriterResolver
- Specified by:
getChannelStreamWriterResolverin interfaceChannelStreamWriterResolverManager
-
setChannelStreamWriterResolver
- Specified by:
setChannelStreamWriterResolverin interfaceChannelStreamWriterResolverManager
-
resolveChannelStreamWriterResolver
- Specified by:
resolveChannelStreamWriterResolverin interfaceChannelStreamWriterResolverManager
-
addPendingRequest
Add a channel request to the tracked pending ones if reply is expected- Parameters:
request- The request typewantReply-trueif reply is expected- Returns:
- The allocated
Datetimestamp -nullif no reply is expected (in which case the request is not tracked) - Throws:
IllegalArgumentException- If the request is already being tracked- See Also:
-
removePendingRequest
Removes a channel request from the tracked ones- Parameters:
request- The request type- Returns:
- The allocated
Datetimestamp -nullif the specified request type is not being tracked or has not been added to the tracked ones to begin with - See Also:
-
handleRequest
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_REQUESTreceived- Specified by:
handleRequestin interfaceChannel- Parameters:
buffer- The rest of the message dataBufferafter decoding the channel identifiers- Throws:
IOException- If failed to handle the message
-
handleChannelRequest
protected void handleChannelRequest(String req, boolean wantReply, Buffer buffer) throws IOException - Throws:
IOException
-
handleUnknownChannelRequest
protected void handleUnknownChannelRequest(String req, boolean wantReply, Buffer buffer) throws IOException Called when none of the register request handlers reported handling the request- Parameters:
req- The request typewantReply- Whether reply is requestedbuffer- TheBuffercontaining extra request-specific data- Throws:
IOException- If failed to send the response (if needed)- See Also:
-
handleInternalRequest
protected RequestHandler.Result handleInternalRequest(String req, boolean wantReply, Buffer buffer) throws IOException Called byhandleUnknownChannelRequest(String, boolean, Buffer)in order to allow channel request handling if none of the registered handlers processed the request - last chance.- Parameters:
req- The request typewantReply- Whether reply is requestedbuffer- TheBuffercontaining extra request-specific data- Returns:
- The handling result - if
nullorUnsupportedand reply is required then a failure message will be sent - Throws:
IOException- If failed to process the request internally
-
sendResponse
protected IoWriteFuture sendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply) throws IOException - Throws:
IOException
-
init
Description copied from interface:ChannelInvoked when the local channel is initial created- Specified by:
initin interfaceChannel- Parameters:
service- TheConnectionServicethrough which the channel is initializedsession- TheSessionassociated with the channelid- The locally assigned channel identifier (UINT32 represented as along)- Throws:
IOException- If failed to process the initialization
-
signalChannelInitialized
- Throws:
IOException
-
signalChannelInitialized
-
signalChannelOpenSuccess
protected void signalChannelOpenSuccess() -
signalChannelOpenSuccess
-
isInitialized
public boolean isInitialized()- Specified by:
isInitializedin interfaceChannel- Returns:
trueif call toChannel.init(ConnectionService, Session, long)was successfully completed
-
handleChannelRegistrationResult
public void handleChannelRegistrationResult(ConnectionService service, Session session, long channelId, boolean registered) Description copied from interface:ChannelInvoked after being successfully registered by the connection service - should throw aRuntimeExceptionif not registered- Specified by:
handleChannelRegistrationResultin interfaceChannel- Parameters:
service- TheConnectionServicethrough which the channel is registeredsession- TheSessionassociated with the channelchannelId- The locally assigned channel identifier (UINT32 represented as along)registered- Whether registration was successful or not
-
signalChannelOpenFailure
-
signalChannelOpenFailure
-
notifyStateChanged
-
notifyStateChanged
-
addChannelListener
Description copied from interface:ChannelListenerManagerAdd a channel listener- Specified by:
addChannelListenerin interfaceChannelListenerManager- Parameters:
listener- TheChannelListenerto add - notnull
-
removeChannelListener
Description copied from interface:ChannelListenerManagerRemove a channel listener- Specified by:
removeChannelListenerin interfaceChannelListenerManager- Parameters:
listener- TheChannelListenerto remove
-
getChannelListenerProxy
- Specified by:
getChannelListenerProxyin interfaceChannelListenerManager- Returns:
- A (never
nullproxyChannelListenerthat represents all the currently registered listeners. Any method invocation on the proxy is replicated to the currently registered listeners
-
handleClose
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_CLOSEreceived- Specified by:
handleClosein interfaceChannel- Throws:
IOException- If failed to handle the message
-
getInnerCloseable
- Specified by:
getInnerCloseablein classAbstractInnerCloseable
-
preClose
protected void preClose()Description copied from class:AbstractCloseablepreClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true- Overrides:
preClosein classAbstractCloseable
-
handleChannelUnregistration
Description copied from interface:ChannelCalled by the connection service to inform the channel that it has bee unregistered.- Specified by:
handleChannelUnregistrationin interfaceChannel- Parameters:
service- TheConnectionServicethrough which the channel is unregistered
-
signalChannelClosed
-
signalChannelClosed
-
invokeChannelSignaller
- Throws:
Throwable
-
writePacket
Description copied from interface:ChannelEncode and send the given buffer. Note: for session packets the buffer has to have 5 bytes free at the beginning to allow the encoding to take place. Also, the write position of the buffer has to be set to the position of the last byte to write.- Specified by:
writePacketin interfaceChannel- Parameters:
buffer- the buffer to encode and send. NOTE: the buffer must not be touched until the returned write future is completed.- Returns:
- An
IoWriteFuturethat can be used to check when the packet has actually been sent - Throws:
IOException- if an error occurred when encoding or sending the packet
-
mayWrite
protected boolean mayWrite() -
handleData
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_DATAreceived- Specified by:
handleDatain interfaceChannel- Parameters:
buffer- The rest of the message dataBufferafter decoding the channel identifiers- Throws:
IOException- If failed to handle the message
-
handleExtendedData
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_EXTENDED_DATAreceived- Specified by:
handleExtendedDatain interfaceChannel- Parameters:
buffer- The rest of the message dataBufferafter decoding the channel identifiers- Throws:
IOException- If failed to handle the message
-
validateIncomingDataSize
- Throws:
IOException
-
getPacketValidator
Retrieves the currently setAbstractChannel.PacketValidator.- Returns:
- the validator, never
null
-
setPacketValidator
Sets aAbstractChannel.PacketValidator.- Parameters:
validator- the validator to set, ifnulltheDEFAULT_PACKET_VALIDATORis set
-
handleEof
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_EOFreceived- Specified by:
handleEofin interfaceChannel- Throws:
IOException- If failed to handle the message
-
isEofSignalled
public boolean isEofSignalled()- Specified by:
isEofSignalledin interfaceChannel- Returns:
trueif the peer signaled that it will not send any more data- See Also:
-
handleWindowAdjust
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_WINDOW_ADJUSTreceived- Specified by:
handleWindowAdjustin interfaceChannel- Parameters:
buffer- The rest of the message dataBufferafter decoding the channel identifiers- Throws:
IOException- If failed to handle the message
-
handleSuccess
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_SUCCESSreceived- Specified by:
handleSuccessin interfaceChannel- Throws:
IOException- If failed to handle the message
-
handleFailure
Description copied from interface:ChannelInvoked whenSSH_MSG_CHANNEL_FAILUREreceived- Specified by:
handleFailurein interfaceChannel- Throws:
IOException- If failed to handle the message
-
doWriteData
- Throws:
IOException
-
doWriteExtendedData
- Throws:
IOException
-
sendEof
SendsSSH_MSG_CHANNEL_EOFprovided not already sent and current channel state allows it.- Returns:
- The
IoWriteFutureof the sent packet -nullif message not sent due to channel state (or already sent) - Throws:
IOException- If failed to send the packet
-
isEofSent
public boolean isEofSent() -
getProperties
Description copied from interface:PropertyResolverA map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.
Note: the type of the mapped property should match the expected configuration value type -
Long, Integer, Boolean, String, etc.... If it doesn't, thetoString()result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is alongthen it will be parsed into one. Also, if the mapped value is anIntegerbut alongis expected, then it will be converted into one.- Specified by:
getPropertiesin interfacePropertyResolver- Returns:
- a valid
Mapcontaining configuration values, nevernull. Note: may be immutable.
-
getAttributesCount
public int getAttributesCount()- Specified by:
getAttributesCountin interfaceAttributeRepository- Returns:
- Current number of user-defined attributes stored in the repository
-
getAttribute
Description copied from interface:AttributeRepositoryReturns the value of the user-defined attribute.- Specified by:
getAttributein interfaceAttributeRepository- Type Parameters:
T- The generic attribute type- Parameters:
key- The key of the attribute; must not benull.- Returns:
nullif there is no value associated with the specified key
-
attributeKeys
- Specified by:
attributeKeysin interfaceAttributeRepository- Returns:
- A
Collectionsnapshot of all the currently registered attributes in the repository
-
computeAttributeIfAbsent
public <T> T computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key, Function<? super AttributeRepository.AttributeKey<T>, ? extends T> resolver) Description copied from interface:AttributeStoreIf the specified key is not already associated with a value (or is mapped tonull), attempts to compute its value using the given mapping function and enters it into this map unlessnull.- Specified by:
computeAttributeIfAbsentin interfaceAttributeStore- Type Parameters:
T- The generic attribute type- Parameters:
key- The key of the attribute; must not benull.resolver- The (nevernull) mapping function to use if value not already mapped. If returnsnullthen value is not mapped to the provided key.- Returns:
- The resolved value -
nullif value not mapped and resolver did not return a non-nullvalue for it
-
setAttribute
Description copied from interface:AttributeStoreSets a user-defined attribute.- Specified by:
setAttributein interfaceAttributeStore- Type Parameters:
T- The generic attribute type- Parameters:
key- The key of the attribute; must not benull.value- The value of the attribute; must not benull.- Returns:
- The old value of the attribute;
nullif it is new.
-
removeAttribute
Description copied from interface:AttributeStoreRemoves the user-defined attribute- Specified by:
removeAttributein interfaceAttributeStore- Type Parameters:
T- The generic attribute type- Parameters:
key- The key of the attribute; must not benull.- Returns:
- The removed value;
nullif no previous value
-
clearAttributes
public void clearAttributes()Description copied from interface:AttributeStoreRemoves all currently stored user-defined attributes- Specified by:
clearAttributesin interfaceAttributeStore
-
configureWindow
protected void configureWindow() -
sendWindowAdjust
- Throws:
IOException
-
toString
-