public interface Session extends SessionContext, MutableUserHolder, KexFactoryManager, SessionListenerManager, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, ChannelListenerManager, ChannelStreamWriterResolverManager, PortForwardingEventListenerManager, UnknownChannelReferenceHandlerManager, FactoryManagerHolder, PortForwardingInformationProvider
null/empty if the
session is not yet authenticatedSessionHeartbeatController.HeartbeatTypeAttributeRepository.AttributeKey<T>DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTHEMPTYNONE| Modifier and Type | Method and Description |
|---|---|
default Buffer |
createBuffer(byte cmd)
Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.
|
Buffer |
createBuffer(byte cmd,
int estimatedSize)
Create a new buffer for the specified SSH packet and reserve the needed space (5 bytes) for the packet header.
|
void |
disconnect(int reason,
String msg)
Send a disconnect packet with the given reason and message.
|
void |
exceptionCaught(Throwable t)
Handle any exceptions that occurred on this session.
|
Duration |
getAuthTimeout() |
Instant |
getAuthTimeoutStart() |
Duration |
getIdleTimeout() |
Instant |
getIdleTimeoutStart() |
IoSession |
getIoSession() |
KeyExchange |
getKex() |
default SocketAddress |
getLocalAddress() |
default SocketAddress |
getRemoteAddress() |
<T extends Service> |
getService(Class<T> clazz)
Get the service of the specified type.
|
TimeoutIndicator |
getTimeoutStatus()
Check if timeout has occurred.
|
Buffer |
prepareBuffer(byte cmd,
Buffer buffer)
Prepare a new "clean" buffer while reserving the needed space (5 bytes) for the packet header.
|
KeyExchangeFuture |
reExchangeKeys()
Initiate a new key exchange.
|
default Buffer |
request(String request,
Buffer buffer,
Duration timeout)
Send a global request and wait for the response.
|
Buffer |
request(String request,
Buffer buffer,
long maxWaitMillis)
Send a global request and wait for the response.
|
default Buffer |
request(String request,
Buffer buffer,
long timeout,
TimeUnit unit)
Send a global request and wait for the response.
|
Instant |
resetAuthTimeout()
Re-start the authentication timeout timer
|
Instant |
resetIdleTimeout()
Re-start idle timeout timer
|
default <T> T |
resolveAttribute(AttributeRepository.AttributeKey<T> key) |
static <T> T |
resolveAttribute(Session session,
AttributeRepository.AttributeKey<T> key)
Attempts to use the session's attribute, if not found then tries the factory manager
|
IoWriteFuture |
sendDebugMessage(boolean display,
Object msg,
String lang)
Sends an
SSH_MSG_DEBUG to the peer session |
IoWriteFuture |
sendIgnoreMessage(byte... data)
Sends an
SSH_MSG_IGNORE to the peer session |
void |
setAuthenticated() |
void |
startService(String name,
Buffer buffer) |
IoWriteFuture |
writePacket(Buffer buffer)
Encode and send the given buffer.
|
default IoWriteFuture |
writePacket(Buffer buffer,
Duration timeout)
Encode and send the given buffer with the specified timeout.
|
default IoWriteFuture |
writePacket(Buffer buffer,
long maxWaitMillis)
Encode and send the given buffer with the specified timeout.
|
IoWriteFuture |
writePacket(Buffer buffer,
long timeout,
TimeUnit unit)
Encode and send the given buffer with the specified timeout.
|
getCipherInformation, getClientKexProposals, getClientVersion, getCompressionInformation, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getServerKexProposals, getServerVersion, getSessionId, isAuthenticated, isDataIntegrityTransport, isSecureSessionTransport, isServerSession, isValidVersionPrefixdisableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeatgetBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty, isEmpty, isEmptyclearAttributes, computeAttributeIfAbsent, removeAttribute, setAttributeattributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePairaddCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListenersetUsernamegetUsernamegetCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNamesgetSignatureFactories, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNamesgetSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNamesgetKexExtensionHandler, setKexExtensionHandleraddSessionListener, getSessionListenerProxy, removeSessionListenergetReservedSessionMessagesHandler, setReservedSessionMessagesHandlergetSessionDisconnectHandler, setSessionDisconnectHandleraddChannelListener, getChannelListenerProxy, removeChannelListenergetChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolveraddPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListenergetUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandlergetFactoryManagergetBoundLocalPortForwards, getBoundRemotePortForward, getLocalForwardsBindings, getRemoteForwardsBindings, getStartedLocalPortForwards, getStartedRemotePortForwards, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPortdefault Buffer createBuffer(byte cmd)
cmd - the SSH commandcreateBuffer(byte, int)Buffer createBuffer(byte cmd, int estimatedSize)
cmd - The SSH command to initialize the buffer withestimatedSize - Estimated number of bytes the buffer will hold, 0 if unknown.prepareBuffer(byte, Buffer)Buffer prepareBuffer(byte cmd, Buffer buffer)
cmd - The SSH command to initialize the buffer withbuffer - The Buffer instance to initializeIoWriteFuture sendDebugMessage(boolean display, Object msg, String lang) throws IOException
SSH_MSG_DEBUG to the peer sessiondisplay - true if OK to display the message at the peer as-ismsg - The message object whose toString() value to be used - if null then the
"null" string is sentlang - The language - null/empty if some pre-agreed default is usedIoWriteFuture that can be used to check when the packet has actually been sentIOException - if an error occurred when encoding or sending the packetIoWriteFuture sendIgnoreMessage(byte... data) throws IOException
SSH_MSG_IGNORE to the peer sessiondata - The message dataIoWriteFuture that can be used to check when the packet has actually been sentIOException - if an error occurred when encoding or sending the packetIoWriteFuture writePacket(Buffer buffer) throws IOException
buffer - the buffer to encode and sendIoWriteFuture that can be used to check when the packet has actually been sentIOException - if an error occurred when encoding sending the packetdefault IoWriteFuture writePacket(Buffer buffer, Duration timeout) throws IOException
IoWriteFuture will be set with a
TimeoutException exception to indicate a timeout.buffer - the buffer to encode and spendtimeout - the (never null) timeout value - its milliseconds value
will be usedIOException - if an error occurred when encoding or sending the packetwritePacket(Buffer, long)default IoWriteFuture writePacket(Buffer buffer, long maxWaitMillis) throws IOException
IoWriteFuture will be set with a
TimeoutException exception to indicate a timeout.buffer - the buffer to encode and spendmaxWaitMillis - the timeout in millisecondsIOException - if an error occurred when encoding or sending the packetIoWriteFuture writePacket(Buffer buffer, long timeout, TimeUnit unit) throws IOException
IoWriteFuture will be set with a
TimeoutException exception to indicate a timeout.buffer - the buffer to encode and spendtimeout - the timeoutunit - the time unit of the timeout parameterIOException - if an error occurred when encoding or sending the packetdefault Buffer request(String request, Buffer buffer, long timeout, TimeUnit unit) throws IOException
SSH_MSG_GLOBAL_REQUEST with a result expected, else it will time outrequest - the request name - used mainly for logging and debuggingbuffer - the buffer containing the global requesttimeout - The number of time units to wait - must be positiveunit - The TimeUnit to wait for the responsenull otherwise.IOException - if an error occurred when encoding or sending the packetSocketTimeoutException - If no response received within specified timeoutdefault Buffer request(String request, Buffer buffer, Duration timeout) throws IOException
SSH_MSG_GLOBAL_REQUEST with a result expected, else it will time outrequest - the request name - used mainly for logging and debuggingbuffer - the buffer containing the global requesttimeout - The (never null) timeout to wait - its milliseconds value is usednull otherwise.IOException - if an error occurred when encoding or sending the packetSocketTimeoutException - If no response received within specified timeoutBuffer request(String request, Buffer buffer, long maxWaitMillis) throws IOException
SSH_MSG_GLOBAL_REQUEST with a result expected, else it will time outrequest - the request name - used mainly for logging and debuggingbuffer - the buffer containing the global requestmaxWaitMillis - Max. time to wait for response (millis) - must be positivenull otherwise.IOException - if an error occurred when encoding or sending the packetSocketTimeoutException - If no response received within specified timeoutvoid exceptionCaught(Throwable t)
SshException with a positive error codet - the exception to processKeyExchangeFuture reExchangeKeys() throws IOException
KeyExchangeFuture for awaiting the completion of the exchangeIOException - If failed to request keys re-negotiation<T extends Service> T getService(Class<T> clazz)
T - The generic Service typeclazz - The service classIllegalStateException - If failed to find a matching servicedefault SocketAddress getLocalAddress()
getLocalAddress in interface ConnectionEndpointsIndicatordefault SocketAddress getRemoteAddress()
getRemoteAddress in interface ConnectionEndpointsIndicatorTimeoutIndicator getTimeoutStatus()
nullDuration getIdleTimeout()
Instant getIdleTimeoutStart()
Instant resetIdleTimeout()
getIdleTimeoutStart()Duration getAuthTimeout()
Instant getAuthTimeoutStart()
Instant resetAuthTimeout()
getAuthTimeoutStart()void setAuthenticated()
throws IOException
IOExceptionKeyExchange getKex()
KeyExchange in progress - null if KEX not started or successfully completedvoid disconnect(int reason,
String msg)
throws IOException
reason - the reason code for this disconnectmsg - the text messageIOException - if an error occurred sending the packetvoid startService(String name, Buffer buffer) throws Exception
name - Service namebuffer - Extra information provided when the service start request was receivedException - If failed to start itdefault <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key)
resolveAttribute in interface AttributeRepositorystatic <T> T resolveAttribute(Session session, AttributeRepository.AttributeKey<T> key)
T - The generic attribute typesession - The Session - ignored if nullkey - The attribute key - never nullnull if not foundFactoryManagerHolder.getFactoryManager(),
FactoryManager.resolveAttribute(FactoryManager, AttributeRepository.AttributeKey)Copyright © 2008–2021 The Apache Software Foundation. All rights reserved.