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.kex.AbstractKexFactoryManager
        
        org.apache.sshd.common.session.helpers.SessionHelper

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AttributeRepository, AttributeStore, MutableUserHolder, UsernameHolder, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, FactoryManagerHolder, PortForwardingEventListenerManager, PortForwardingInformationProvider, KexExtensionHandlerManager, KexFactoryManager, PropertyResolver, ReservedSessionMessagesManager, Session, SessionContext, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesHolder, SignatureFactoriesManager, ConnectionEndpointsIndicator

Direct Known Subclasses:

AbstractSession
```
public abstract class SessionHelper
extends AbstractKexFactoryManager
implements Session
```
Contains split code in order to make AbstractSession class smaller

Nested Class Summary
- 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.session.SessionHeartbeatController
  SessionHeartbeatController.HeartbeatType

Field Summary

Fields
Modifier and Type	Field	Description
`protected Instant`	`authStart`
`protected Instant`	`idleStart`
`protected Map<KexProposalOption,String>`	`initialKexProposal`	Stores the initial KEX proposal after it has been run through the hooks allowing client code to modify it; see `getKexProposal()`.

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.throttle.ChannelStreamWriterResolver
NONE

Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY

Fields inherited from interface org.apache.sshd.common.session.SessionContext
DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SessionHelper(boolean serverSession, FactoryManager factoryManager, IoSession ioSession)`	Create a new session.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<AttributeRepository.AttributeKey<?>>`	`attributeKeys()`
`protected long`	`calculateNextIgnorePacketCount(Random r, long freq, int variance)`
`protected TimeoutIndicator`	`checkAuthenticationTimeout(Instant now, Duration authTimeout)`	Checks if authentication timeout expired
`protected TimeoutIndicator`	`checkForTimeouts()`	Checks whether the session has timed out (both authentication and idle timeouts are checked).
`protected TimeoutIndicator`	`checkIdleTimeout(Instant now, Duration idleTimeout)`	Checks if idle timeout expired
`void`	`clearAttributes()`
`<T> T`	`computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key, Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver)`
`protected Map<KexProposalOption,String>`	`createProposal(String hostKeyTypes)`	Create our proposal for SSH negotiation
`void`	`disconnect(int reason, String msg)`	Send a disconnect packet with the given reason and message.
`protected void`	`doInvokeDebugMessageHandler(Buffer buffer)`	Invoked by `handleDebug(Buffer)` after validating that the buffer structure seems well-formed and also resetting the idle timeout.
`protected void`	`doInvokeIgnoreMessageHandler(Buffer buffer)`	Invoked by `handleDebug(Buffer)` after validating that the buffer structure seems well-formed and also resetting the idle timeout.
`protected boolean`	`doInvokeUnimplementedMessageHandler(int cmd, Buffer buffer)`
`protected List<String>`	`doReadIdentification(Buffer buffer, boolean server)`	Read the remote identification from this buffer.
`void`	`exceptionCaught(Throwable t)`	Handle any exceptions that occurred on this session.
`<T> T`	`getAttribute(AttributeRepository.AttributeKey<T> key)`
`int`	`getAttributesCount()`
`Duration`	`getAuthTimeout()`
`Instant`	`getAuthTimeoutStart()`
`List<SshdSocketAddress>`	`getBoundLocalPortForwards(int port)`
`SshdSocketAddress`	`getBoundRemotePortForward(int port)`
`ChannelStreamWriterResolver`	`getChannelStreamWriterResolver()`
`protected abstract ConnectionService`	`getConnectionService()`
`FactoryManager`	`getFactoryManager()`
`protected Forwarder`	`getForwarder()`
`Duration`	`getIdleTimeout()`
`Instant`	`getIdleTimeoutStart()`
`IoSession`	`getIoSession()`
`protected Map<KexProposalOption,String>`	`getKexProposal()`	Retrieves this side's initial proposal for KEX negotiation.
`List<Map.Entry<SshdSocketAddress,SshdSocketAddress>>`	`getLocalForwardsBindings()`
`PropertyResolver`	`getParentPropertyResolver()`
`Map<String,Object>`	`getProperties()`
`List<Map.Entry<Integer,SshdSocketAddress>>`	`getRemoteForwardsBindings()`
`ReservedSessionMessagesHandler`	`getReservedSessionMessagesHandler()`
`SessionDisconnectHandler`	`getSessionDisconnectHandler()`
`List<SshdSocketAddress>`	`getStartedLocalPortForwards()`
`NavigableSet<Integer>`	`getStartedRemotePortForwards()`
`TimeoutIndicator`	`getTimeoutStatus()`	Check if timeout has occurred.
`UnknownChannelReferenceHandler`	`getUnknownChannelReferenceHandler()`
`String`	`getUsername()`
`protected void`	`handleDebug(Buffer buffer)`
`protected void`	`handleDisconnect(int code, String msg, String lang, Buffer buffer)`
`protected void`	`handleDisconnect(Buffer buffer)`
`protected void`	`handleIgnore(Buffer buffer)`
`protected void`	`handleUnimplemented(Buffer buffer)`
`protected void`	`invokeSessionSignaller(Invoker<SessionListener,Void> invoker)`
`boolean`	`isAuthenticated()`
`boolean`	`isLocalPortForwardingStartedForPort(int port)`	Test if local port forwarding is started
`boolean`	`isRemotePortForwardingStartedForPort(int port)`	Test if remote port forwarding is started
`boolean`	`isServerSession()`
`protected Map<KexProposalOption,String>`	`mergeProposals(Map<KexProposalOption,String> current, Map<KexProposalOption,String> proposal)`
`protected Buffer`	`preProcessEncodeBuffer(int cmd, Buffer buffer)`	Invoked by the session before encoding the buffer in order to make sure that it is at least of size `SSH_PACKET_HEADER_LEN`.
`<T> T`	`removeAttribute(AttributeRepository.AttributeKey<T> key)`
`Instant`	`resetAuthTimeout()`	Re-start the authentication timeout timer
`Instant`	`resetIdleTimeout()`	Re-start idle timeout timer
`protected byte[]`	`resizeKey(byte[] e, int kdfSize, Digest hash, byte[] k, byte[] h)`	Method used while putting new keys into use that will resize the key used to initialize the cipher to the needed length.
`protected String`	`resolveAvailableSignaturesProposal()`	Computes the list of available host key signature algorithms supported.
`protected abstract String`	`resolveAvailableSignaturesProposal(FactoryManager manager)`	Computes the list of available host key signature algorithms supported.
`ChannelStreamWriterResolver`	`resolveChannelStreamWriterResolver()`
`protected String`	`resolveIdentificationString(String configPropName)`	Resolves the identification to send to the peer session by consulting the associated `FactoryManager`.
`protected SocketAddress`	`resolvePeerAddress(SocketAddress knownAddress)`
`protected ReservedSessionMessagesHandler`	`resolveReservedSessionMessagesHandler()`
`protected String`	`resolveSessionKexProposal(String hostKeyTypes)`
`UnknownChannelReferenceHandler`	`resolveUnknownChannelReferenceHandler()`	Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
`IoWriteFuture`	`sendDebugMessage(boolean display, Object msg, String lang)`	Sends an `SSH_MSG_DEBUG` to the peer session
`protected IoWriteFuture`	`sendIdentification(String version, List<String> extraLines)`	Send our identification.
`IoWriteFuture`	`sendIgnoreMessage(byte... data)`	Sends an `SSH_MSG_IGNORE` to the peer session
`protected IoWriteFuture`	`sendNotImplemented(long seqNoValue)`	Sends a `SSH_MSG_UNIMPLEMENTED` message
`<T> T`	`setAttribute(AttributeRepository.AttributeKey<T> key, T value)`
`void`	`setAuthenticated()`
`void`	`setChannelStreamWriterResolver(ChannelStreamWriterResolver resolver)`
`void`	`setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)`
`void`	`setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)`
`void`	`setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)`
`void`	`setUsername(String username)`
`protected void`	`signalDisconnect(int code, String msg, String lang, boolean initiator)`
`protected void`	`signalDisconnect(SessionListener listener, int code, String msg, String lang, boolean initiator)`
`protected void`	`signalExceptionCaught(Throwable t)`
`protected void`	`signalExceptionCaught(SessionListener listener, Throwable t)`
`protected void`	`signalNegotiationEnd(Map<KexProposalOption,String> c2sOptions, Map<KexProposalOption,String> s2cOptions, Map<KexProposalOption,String> negotiatedGuess, Throwable reason)`
`protected void`	`signalNegotiationEnd(SessionListener listener, Map<KexProposalOption,String> c2sOptions, Map<KexProposalOption,String> s2cOptions, Map<KexProposalOption,String> negotiatedGuess, Throwable reason)`
`protected void`	`signalNegotiationOptionsCreated(Map<KexProposalOption,String> proposal)`
`protected void`	`signalNegotiationOptionsCreated(SessionListener listener, Map<KexProposalOption,String> proposal)`
`protected void`	`signalNegotiationStart(Map<KexProposalOption,String> c2sOptions, Map<KexProposalOption,String> s2cOptions)`
`protected void`	`signalNegotiationStart(SessionListener listener, Map<KexProposalOption,String> c2sOptions, Map<KexProposalOption,String> s2cOptions)`
`protected void`	`signalPeerIdentificationReceived(String version, List<String> extraLines)`
`protected void`	`signalPeerIdentificationReceived(SessionListener listener, String version, List<String> extraLines)`
`protected void`	`signalReadPeerIdentificationLine(String line, List<String> extraLines)`
`protected void`	`signalReadPeerIdentificationLine(SessionListener listener, String version, List<String> extraLines)`
`protected void`	`signalSendIdentification(String version, List<String> extraLines)`
`protected void`	`signalSendIdentification(SessionListener listener, String version, List<String> extraLines)`
`protected void`	`signalSessionClosed()`
`protected void`	`signalSessionClosed(SessionListener listener)`
`protected void`	`signalSessionCreated(IoSession ioSession)`
`protected void`	`signalSessionCreated(SessionListener listener)`
`protected void`	`signalSessionEstablished(IoSession ioSession)`
`protected void`	`signalSessionEstablished(SessionListener listener)`
`protected void`	`signalSessionEvent(SessionListener.Event event)`	Sends a session event to all currently registered session listeners
`protected void`	`signalSessionEvent(SessionListener listener, SessionListener.Event event)`
`String`	`toString()`

Methods inherited from class org.apache.sshd.common.kex.AbstractKexFactoryManager
getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, setMacFactories, setSignatureFactories

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable
doCloseGracefully, doCloseImmediately, getInnerCloseable

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, preClose, 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.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager
resolveChannelStreamWriter

Methods inherited from interface org.apache.sshd.common.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager
getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty, isEmpty

Methods inherited from interface org.apache.sshd.common.session.Session
createBuffer, createBuffer, getKex, getLocalAddress, getRemoteAddress, getService, prepareBuffer, reExchangeKeys, request, request, request, request, resolveAttribute, startService, writePacket, writePacket, writePacket, writePacket

Methods inherited from interface org.apache.sshd.common.session.SessionContext
getCipherInformation, getClientKexProposals, getClientVersion, getCompressionInformation, getKexNegotiationResult, getKexState, getMacInformation, getNegotiatedKexParameter, getServerKexProposals, getServerVersion, getSessionId

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface org.apache.sshd.common.session.SessionListenerManager
addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesHolder
getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager
setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

- Field Detail
  - authStart
```
protected Instant authStart
```
  - idleStart
```
protected Instant idleStart
```
  - initialKexProposal
```
protected Map<KexProposalOption,String> initialKexProposal
```
    Stores the initial KEX proposal after it has been run through the hooks allowing client code to modify it; see getKexProposal(). The same proposal is then used for the initial KEX and for any re-KEX.
- Constructor Detail
  - SessionHelper
```
protected SessionHelper(boolean serverSession,
                        FactoryManager factoryManager,
                        IoSession ioSession)
```
    Create a new session.
    
    Parameters:
    
    serverSession - true if this is a server session, false if client one
    
    factoryManager - the factory manager
    
    ioSession - the underlying I/O session
- Method Detail
  - getIoSession
```
public IoSession getIoSession()
```
    Specified by:
    
    getIoSession in interface Session
    
    Returns:
    
    The IoSession associated to this session
  - isServerSession
```
public boolean isServerSession()
```
    Specified by:
    
    isServerSession in interface SessionContext
  - getFactoryManager
```
public FactoryManager getFactoryManager()
```
    Specified by:
    
    getFactoryManager in interface FactoryManagerHolder
    
    Returns:
    
    The currently associated FactoryManager
  - getParentPropertyResolver
```
public PropertyResolver getParentPropertyResolver()
```
    Specified by:
    
    getParentPropertyResolver in interface PropertyResolver
  - getProperties
```
public Map<String,Object> getProperties()
```
    Specified by:
    
    getProperties in interface PropertyResolver
  - getAttributesCount
```
public int getAttributesCount()
```
    Specified by:
    
    getAttributesCount in interface AttributeRepository
  - getAttribute
```
public <T> T getAttribute(AttributeRepository.AttributeKey<T> key)
```
    Specified by:
    
    getAttribute in interface AttributeRepository
  - attributeKeys
```
public Collection<AttributeRepository.AttributeKey<?>> attributeKeys()
```
    Specified by:
    
    attributeKeys in interface AttributeRepository
  - computeAttributeIfAbsent
```
public <T> T computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key,
                                      Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver)
```
    Specified by:
    
    computeAttributeIfAbsent in interface AttributeStore
  - setAttribute
```
public <T> T setAttribute(AttributeRepository.AttributeKey<T> key,
                          T value)
```
    Specified by:
    
    setAttribute in interface AttributeStore
  - removeAttribute
```
public <T> T removeAttribute(AttributeRepository.AttributeKey<T> key)
```
    Specified by:
    
    removeAttribute in interface AttributeStore
  - clearAttributes
```
public void clearAttributes()
```
    Specified by:
    
    clearAttributes in interface AttributeStore
  - getUsername
```
public String getUsername()
```
    Specified by:
    
    getUsername in interface UsernameHolder
  - setUsername
```
public void setUsername(String username)
```
    Specified by:
    
    setUsername in interface MutableUserHolder
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Specified by:
    
    isAuthenticated in interface SessionContext
  - setAuthenticated
```
public void setAuthenticated()
                      throws IOException
```
    Specified by:
    
    setAuthenticated in interface Session
    
    Throws:
    
    IOException
  - checkForTimeouts
```
protected TimeoutIndicator checkForTimeouts()
                                     throws IOException
```
    Checks whether the session has timed out (both authentication and idle timeouts are checked). If the session has timed out, a DISCONNECT message will be sent.
    
    Returns:
    
    An indication whether timeout has been detected
    
    Throws:
    
    IOException - If failed to check
    
    See Also:
    
    checkAuthenticationTimeout(Instant, Duration), checkIdleTimeout(Instant, Duration)
  - getAuthTimeoutStart
```
public Instant getAuthTimeoutStart()
```
    Specified by:
    
    getAuthTimeoutStart in interface Session
    
    Returns:
    
    The timestamp value (milliseconds since EPOCH) when timer was started
  - resetAuthTimeout
```
public Instant resetAuthTimeout()
```
    Description copied from interface: Session
    
    Re-start the authentication timeout timer
    
    Specified by:
    
    resetAuthTimeout in interface Session
    
    Returns:
    
    The timestamp value (milliseconds since EPOCH) when timer was started
    
    See Also:
    
    Session.getAuthTimeoutStart()
  - checkAuthenticationTimeout
```
protected TimeoutIndicator checkAuthenticationTimeout(Instant now,
                                                      Duration authTimeout)
```
    Checks if authentication timeout expired
    
    Parameters:
    
    now - The current time in millis
    
    authTimeout - The configured timeout - if non-positive then no timeout
    
    Returns:
    
    A TimeoutIndicator specifying the timeout status and disconnect reason message if timeout expired, null or NoTimeout if no timeout occurred
    
    See Also:
    
    getAuthTimeout()
  - getIdleTimeoutStart
```
public Instant getIdleTimeoutStart()
```
    Specified by:
    
    getIdleTimeoutStart in interface Session
    
    Returns:
    
    The timestamp value (milliseconds since EPOCH) when timer was started
  - checkIdleTimeout
```
protected TimeoutIndicator checkIdleTimeout(Instant now,
                                            Duration idleTimeout)
```
    Checks if idle timeout expired
    
    Parameters:
    
    now - The current time in millis
    
    idleTimeout - The configured timeout - if non-positive then no timeout
    
    Returns:
    
    A TimeoutIndicator specifying the timeout status and disconnect reason message if timeout expired, null or NoTimeout if no timeout occurred
    
    See Also:
    
    getIdleTimeout()
  - resetIdleTimeout
```
public Instant resetIdleTimeout()
```
    Description copied from interface: Session
    
    Re-start idle timeout timer
    
    Specified by:
    
    resetIdleTimeout in interface Session
    
    Returns:
    
    The timestamp value (milliseconds since EPOCH) when timer was started
    
    See Also:
    
    Session.getIdleTimeoutStart()
  - getTimeoutStatus
```
public TimeoutIndicator getTimeoutStatus()
```
    Description copied from interface: Session
    
    Check if timeout has occurred.
    
    Specified by:
    
    getTimeoutStatus in interface Session
    
    Returns:
    
    the timeout status - never null
  - getReservedSessionMessagesHandler
```
public ReservedSessionMessagesHandler getReservedSessionMessagesHandler()
```
    Specified by:
    
    getReservedSessionMessagesHandler in interface ReservedSessionMessagesManager
    
    Returns:
    
    The currently registered ReservedSessionMessagesHandler - may be null
  - setReservedSessionMessagesHandler
```
public void setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)
```
    Specified by:
    
    setReservedSessionMessagesHandler in interface ReservedSessionMessagesManager
    
    Parameters:
    
    handler - The ReservedSessionMessagesHandler to use - may be null
  - getSessionDisconnectHandler
```
public SessionDisconnectHandler getSessionDisconnectHandler()
```
    Specified by:
    
    getSessionDisconnectHandler in interface SessionDisconnectHandlerManager
  - setSessionDisconnectHandler
```
public void setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)
```
    Specified by:
    
    setSessionDisconnectHandler in interface SessionDisconnectHandlerManager
  - handleIgnore
```
protected void handleIgnore(Buffer buffer)
                     throws Exception
```
    Throws:
    
    Exception
  - doInvokeIgnoreMessageHandler
```
protected void doInvokeIgnoreMessageHandler(Buffer buffer)
                                     throws Exception
```
    Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout. By default, retrieves the ReservedSessionMessagesHandler and invokes its handleIgnoreMessage method.
    
    Parameters:
    
    buffer - The input Buffer
    
    Throws:
    
    Exception - if failed to handle the message
  - sendNotImplemented
```
protected IoWriteFuture sendNotImplemented(long seqNoValue)
                                    throws IOException
```
    Sends a SSH_MSG_UNIMPLEMENTED message
    
    Parameters:
    
    seqNoValue - The referenced sequence number
    
    Returns:
    
    An IoWriteFuture that can be used to wait for packet write completion
    
    Throws:
    
    IOException - if an error occurred sending the packet
  - handleUnimplemented
```
protected void handleUnimplemented(Buffer buffer)
                            throws Exception
```
    Throws:
    
    Exception
  - doInvokeUnimplementedMessageHandler
```
protected boolean doInvokeUnimplementedMessageHandler(int cmd,
                                                      Buffer buffer)
                                               throws Exception
```
    Parameters:
    
    cmd - The unimplemented command
    
    buffer - The input Buffer
    
    Returns:
    
    Result of invoking handleUnimplementedMessage
    
    Throws:
    
    Exception - if failed to handle the message
  - sendDebugMessage
```
public IoWriteFuture sendDebugMessage(boolean display,
                                      Object msg,
                                      String lang)
                               throws IOException
```
    Description copied from interface: Session
    
    Sends an SSH_MSG_DEBUG to the peer session
    
    Specified by:
    
    sendDebugMessage in interface Session
    
    Parameters:
    
    display - true if OK to display the message at the peer as-is
    
    msg - The message object whose toString() value to be used - if null then the "null" string is sent
    
    lang - The language - null/empty if some pre-agreed default is used
    
    Returns:
    
    An IoWriteFuture that can be used to check when the packet has actually been sent
    
    Throws:
    
    IOException - if an error occurred when encoding or sending the packet
    
    See Also:
    
    RFC 4253 - section 11.3
  - handleDebug
```
protected void handleDebug(Buffer buffer)
                    throws Exception
```
    Throws:
    
    Exception
  - doInvokeDebugMessageHandler
```
protected void doInvokeDebugMessageHandler(Buffer buffer)
                                    throws Exception
```
    Invoked by handleDebug(Buffer) after validating that the buffer structure seems well-formed and also resetting the idle timeout. By default, retrieves the ReservedSessionMessagesHandler and invokes its handleDebugMessage method.
    
    Parameters:
    
    buffer - The input Buffer
    
    Throws:
    
    Exception - if failed to handle the message
  - resolveReservedSessionMessagesHandler
```
protected ReservedSessionMessagesHandler resolveReservedSessionMessagesHandler()
```
  - getUnknownChannelReferenceHandler
```
public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()
```
    Specified by:
    
    getUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager
    
    Returns:
    
    The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException
  - setUnknownChannelReferenceHandler
```
public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)
```
    Specified by:
    
    setUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager
    
    Parameters:
    
    unknownChannelReferenceHandler - The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException
  - resolveUnknownChannelReferenceHandler
```
public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()
```
    Description copied from interface: UnknownChannelReferenceHandlerManager
    
    Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
    
    Specified by:
    
    resolveUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager
    
    Returns:
    
    The resolved handler instance
  - getChannelStreamWriterResolver
```
public ChannelStreamWriterResolver getChannelStreamWriterResolver()
```
    Specified by:
    
    getChannelStreamWriterResolver in interface ChannelStreamWriterResolverManager
  - setChannelStreamWriterResolver
```
public void setChannelStreamWriterResolver(ChannelStreamWriterResolver resolver)
```
    Specified by:
    
    setChannelStreamWriterResolver in interface ChannelStreamWriterResolverManager
  - resolveChannelStreamWriterResolver
```
public ChannelStreamWriterResolver resolveChannelStreamWriterResolver()
```
    Specified by:
    
    resolveChannelStreamWriterResolver in interface ChannelStreamWriterResolverManager
  - sendIgnoreMessage
```
public IoWriteFuture sendIgnoreMessage(byte... data)
                                throws IOException
```
    Description copied from interface: Session
    
    Sends an SSH_MSG_IGNORE to the peer session
    
    Specified by:
    
    sendIgnoreMessage in interface Session
    
    Parameters:
    
    data - The message data
    
    Returns:
    
    An IoWriteFuture that can be used to check when the packet has actually been sent
    
    Throws:
    
    IOException - if an error occurred when encoding or sending the packet
    
    See Also:
    
    RFC 4253 - section 11.2
  - signalSessionEstablished
```
protected void signalSessionEstablished(IoSession ioSession)
                                 throws Exception
```
    Throws:
    
    Exception
  - signalSessionEstablished
```
protected void signalSessionEstablished(SessionListener listener)
```
  - signalSessionCreated
```
protected void signalSessionCreated(IoSession ioSession)
                             throws Exception
```
    Throws:
    
    Exception
  - signalSessionCreated
```
protected void signalSessionCreated(SessionListener listener)
```
  - signalSendIdentification
```
protected void signalSendIdentification(String version,
                                        List<String> extraLines)
                                 throws Exception
```
    Throws:
    
    Exception
  - signalSendIdentification
```
protected void signalSendIdentification(SessionListener listener,
                                        String version,
                                        List<String> extraLines)
```
  - signalReadPeerIdentificationLine
```
protected void signalReadPeerIdentificationLine(String line,
                                                List<String> extraLines)
                                         throws Exception
```
    Throws:
    
    Exception
  - signalReadPeerIdentificationLine
```
protected void signalReadPeerIdentificationLine(SessionListener listener,
                                                String version,
                                                List<String> extraLines)
```
  - signalPeerIdentificationReceived
```
protected void signalPeerIdentificationReceived(String version,
                                                List<String> extraLines)
                                         throws Exception
```
    Throws:
    
    Exception
  - signalPeerIdentificationReceived
```
protected void signalPeerIdentificationReceived(SessionListener listener,
                                                String version,
                                                List<String> extraLines)
```
  - signalSessionEvent
```
protected void signalSessionEvent(SessionListener.Event event)
                           throws Exception
```
    Sends a session event to all currently registered session listeners
    
    Parameters:
    
    event - The event to send
    
    Throws:
    
    Exception - If any of the registered listeners threw an exception.
  - signalSessionEvent
```
protected void signalSessionEvent(SessionListener listener,
                                  SessionListener.Event event)
                           throws IOException
```
    Throws:
    
    IOException
  - invokeSessionSignaller
```
protected void invokeSessionSignaller(Invoker<SessionListener,Void> invoker)
                               throws Throwable
```
    Throws:
    
    Throwable
  - resizeKey
```
protected byte[] resizeKey(byte[] e,
                           int kdfSize,
                           Digest hash,
                           byte[] k,
                           byte[] h)
                    throws Exception
```
    Method used while putting new keys into use that will resize the key used to initialize the cipher to the needed length.
    
    Parameters:
    
    e - the key to resize
    
    kdfSize - the cipher key-derivation-factor (in bytes)
    
    hash - the hash algorithm
    
    k - the key exchange k parameter
    
    h - the key exchange h parameter
    
    Returns:
    
    the resized key
    
    Throws:
    
    Exception - if a problem occur while resizing the key
  - resolvePeerAddress
```
protected SocketAddress resolvePeerAddress(SocketAddress knownAddress)
```
    Parameters:
    
    knownAddress - Any externally set peer address - e.g., due to some proxy mechanism meta-data
    
    Returns:
    
    The external address if not null otherwise, the IoSession peer address
  - calculateNextIgnorePacketCount
```
protected long calculateNextIgnorePacketCount(Random r,
                                              long freq,
                                              int variance)
```
  - resolveIdentificationString
```
protected String resolveIdentificationString(String configPropName)
```
    Resolves the identification to send to the peer session by consulting the associated FactoryManager. If a value is set, then it is appended to the standard SessionContext.DEFAULT_SSH_VERSION_PREFIX. Otherwise a default value is returned consisting of the prefix and the core artifact name + version in uppercase - e.g.,' "SSH-2.0-APACHE-SSHD-1.2.3.4"
    
    Parameters:
    
    configPropName - The property used to query the factory manager
    
    Returns:
    
    The resolved identification value
  - sendIdentification
```
protected IoWriteFuture sendIdentification(String version,
                                           List<String> extraLines)
                                    throws Exception
```
    Send our identification.
    
    Parameters:
    
    version - our identification to send
    
    extraLines - Extra lines to send - used only by server sessions
    
    Returns:
    
    IoWriteFuture that can be used to wait for notification that identification has been send
    
    Throws:
    
    Exception - If failed to send the packet
  - doReadIdentification
```
protected List<String> doReadIdentification(Buffer buffer,
                                            boolean server)
                                     throws Exception
```
    Read the remote identification from this buffer. If more data is needed, the buffer will be reset to its original state and a null value will be returned. Else the identification string will be returned and the data read will be consumed from the buffer.
    
    Parameters:
    
    buffer - the buffer containing the identification string
    
    server - true if it is called by the server session, false if by the client session
    
    Returns:
    
    A List of all received remote identification lines until the version line was read or null if more data is needed. The identification line is the last one in the list
    
    Throws:
    
    Exception - if malformed identification found
  - resolveSessionKexProposal
```
protected String resolveSessionKexProposal(String hostKeyTypes)
                                    throws IOException
```
    Throws:
    
    IOException
  - resolveAvailableSignaturesProposal
```
protected String resolveAvailableSignaturesProposal()
                                             throws IOException,
                                                    GeneralSecurityException
```
    Computes the list of available host key signature algorithms supported.
    
    Returns:
    
    A comma-separated list of all the signature protocols to be included in the proposal - null/empty if no proposal
    
    Throws:
    
    IOException - If failed to read/parse the keys data
    
    GeneralSecurityException - If failed to generate the keys
    
    See Also:
    
    getFactoryManager(), resolveAvailableSignaturesProposal(FactoryManager)
  - resolveAvailableSignaturesProposal
```
protected abstract String resolveAvailableSignaturesProposal(FactoryManager manager)
                                                      throws IOException,
                                                             GeneralSecurityException
```
    Computes the list of available host key signature algorithms supported.
    
    Parameters:
    
    manager - The FactoryManager
    
    Returns:
    
    A comma-separated list of all the signature protocols to be included in the proposal - null/empty if no proposal
    
    Throws:
    
    IOException - If failed to read/parse the keys data
    
    GeneralSecurityException - If failed to generate the keys
  - getKexProposal
```
protected Map<KexProposalOption,String> getKexProposal()
                                                      throws Exception
```
    Retrieves this side's initial proposal for KEX negotiation. If no proposal exists yet, one is created and passed though the KexExtensionHandler and the SessionListener for customization, otherwise the previously created proposal for the session is returned.
    
    Returns:
    
    the proposal Map
    
    Throws:
    
    Exception - when no proposal can be created
  - createProposal
```
protected Map<KexProposalOption,String> createProposal(String hostKeyTypes)
                                                      throws IOException
```
    Create our proposal for SSH negotiation
    
    Parameters:
    
    hostKeyTypes - The comma-separated list of supported host key types
    
    Returns:
    
    The proposal Map
    
    Throws:
    
    IOException - If internal problem - e.g., KEX extensions negotiation issue
  - mergeProposals
```
protected Map<KexProposalOption,String> mergeProposals(Map<KexProposalOption,String> current,
                                                             Map<KexProposalOption,String> proposal)
```
  - signalNegotiationOptionsCreated
```
protected void signalNegotiationOptionsCreated(Map<KexProposalOption,String> proposal)
```
  - signalNegotiationOptionsCreated
```
protected void signalNegotiationOptionsCreated(SessionListener listener,
                                               Map<KexProposalOption,String> proposal)
```
  - signalNegotiationStart
```
protected void signalNegotiationStart(Map<KexProposalOption,String> c2sOptions,
                                      Map<KexProposalOption,String> s2cOptions)
```
  - signalNegotiationStart
```
protected void signalNegotiationStart(SessionListener listener,
                                      Map<KexProposalOption,String> c2sOptions,
                                      Map<KexProposalOption,String> s2cOptions)
```
  - signalNegotiationEnd
```
protected void signalNegotiationEnd(Map<KexProposalOption,String> c2sOptions,
                                    Map<KexProposalOption,String> s2cOptions,
                                    Map<KexProposalOption,String> negotiatedGuess,
                                    Throwable reason)
```
  - signalNegotiationEnd
```
protected void signalNegotiationEnd(SessionListener listener,
                                    Map<KexProposalOption,String> c2sOptions,
                                    Map<KexProposalOption,String> s2cOptions,
                                    Map<KexProposalOption,String> negotiatedGuess,
                                    Throwable reason)
```
  - preProcessEncodeBuffer
```
protected Buffer preProcessEncodeBuffer(int cmd,
                                        Buffer buffer)
                                 throws IOException
```
    Invoked by the session before encoding the buffer in order to make sure that it is at least of size SSH_PACKET_HEADER_LEN. This is required in order to efficiently handle the encoding. If necessary, it re-allocates a new buffer and returns it instead.
    
    Parameters:
    
    cmd - The command stored in the buffer
    
    buffer - The original Buffer - assumed to be properly formatted and be of at least the required minimum length.
    
    Returns:
    
    The adjusted Buffer. Note: users may use this method to totally alter the contents of the buffer being sent but it is highly discouraged as it may have unexpected results.
    
    Throws:
    
    IOException - If failed to process the buffer
  - disconnect
```
public void disconnect(int reason,
                       String msg)
                throws IOException
```
    Description copied from interface: Session
    
    Send a disconnect packet with the given reason and message. Once the packet has been sent, the session will be closed asynchronously.
    
    Specified by:
    
    disconnect in interface Session
    
    Parameters:
    
    reason - the reason code for this disconnect
    
    msg - the text message
    
    Throws:
    
    IOException - if an error occurred sending the packet
  - handleDisconnect
```
protected void handleDisconnect(Buffer buffer)
                         throws Exception
```
    Throws:
    
    Exception
  - handleDisconnect
```
protected void handleDisconnect(int code,
                                String msg,
                                String lang,
                                Buffer buffer)
                         throws Exception
```
    Throws:
    
    Exception
  - signalDisconnect
```
protected void signalDisconnect(int code,
                                String msg,
                                String lang,
                                boolean initiator)
```
  - signalDisconnect
```
protected void signalDisconnect(SessionListener listener,
                                int code,
                                String msg,
                                String lang,
                                boolean initiator)
```
  - exceptionCaught
```
public void exceptionCaught(Throwable t)
```
    Handle any exceptions that occurred on this session. The session will be closed and a disconnect packet will be sent before if the given exception is an SshException.
    
    Specified by:
    
    exceptionCaught in interface Session
    
    Parameters:
    
    t - the exception to process
  - signalExceptionCaught
```
protected void signalExceptionCaught(Throwable t)
```
  - signalExceptionCaught
```
protected void signalExceptionCaught(SessionListener listener,
                                     Throwable t)
```
  - signalSessionClosed
```
protected void signalSessionClosed()
```
  - signalSessionClosed
```
protected void signalSessionClosed(SessionListener listener)
```
  - getConnectionService
```
protected abstract ConnectionService getConnectionService()
```
  - getForwarder
```
protected Forwarder getForwarder()
```
  - getLocalForwardsBindings
```
public List<Map.Entry<SshdSocketAddress,SshdSocketAddress>> getLocalForwardsBindings()
```
    Specified by:
    
    getLocalForwardsBindings in interface PortForwardingInformationProvider
    
    Returns:
    
    A snapshot of the currently bound forwarded local ports as "pairs" of local/remote SshdSocketAddress-es
  - isLocalPortForwardingStartedForPort
```
public boolean isLocalPortForwardingStartedForPort(int port)
```
    Description copied from interface: PortForwardingInformationProvider
    
    Test if local port forwarding is started
    
    Specified by:
    
    isLocalPortForwardingStartedForPort in interface PortForwardingInformationProvider
    
    Parameters:
    
    port - The local port
    
    Returns:
    
    true if local port forwarding is started
    
    See Also:
    
    getBoundLocalPortForwards
  - getStartedLocalPortForwards
```
public List<SshdSocketAddress> getStartedLocalPortForwards()
```
    Specified by:
    
    getStartedLocalPortForwards in interface PortForwardingInformationProvider
    
    Returns:
    
    A List snapshot of the currently started local port forward bindings
  - getBoundLocalPortForwards
```
public List<SshdSocketAddress> getBoundLocalPortForwards(int port)
```
    Specified by:
    
    getBoundLocalPortForwards in interface PortForwardingInformationProvider
    
    Parameters:
    
    port - The port number
    
    Returns:
    
    The local bound SshdSocketAddress-es for the port
    
    See Also:
    
    isLocalPortForwardingStartedForPort, PortForwardingInformationProvider.getStartedLocalPortForwards()
  - getRemoteForwardsBindings
```
public List<Map.Entry<Integer,SshdSocketAddress>> getRemoteForwardsBindings()
```
    Specified by:
    
    getRemoteForwardsBindings in interface PortForwardingInformationProvider
    
    Returns:
    
    A snapshot of the currently bound forwarded remote ports as "pairs" of port + bound SshdSocketAddress
  - isRemotePortForwardingStartedForPort
```
public boolean isRemotePortForwardingStartedForPort(int port)
```
    Description copied from interface: PortForwardingInformationProvider
    
    Test if remote port forwarding is started
    
    Specified by:
    
    isRemotePortForwardingStartedForPort in interface PortForwardingInformationProvider
    
    Parameters:
    
    port - The remote port
    
    Returns:
    
    true if remote port forwarding is started
    
    See Also:
    
    getBoundRemotePortForward
  - getStartedRemotePortForwards
```
public NavigableSet<Integer> getStartedRemotePortForwards()
```
    Specified by:
    
    getStartedRemotePortForwards in interface PortForwardingInformationProvider
    
    Returns:
    
    A NavigableSet snapshot of the currently started remote port forwards
  - getBoundRemotePortForward
```
public SshdSocketAddress getBoundRemotePortForward(int port)
```
    Specified by:
    
    getBoundRemotePortForward in interface PortForwardingInformationProvider
    
    Parameters:
    
    port - The port number
    
    Returns:
    
    The remote bound SshdSocketAddress for the port - null if none bound
    
    See Also:
    
    isRemotePortForwardingStartedForPort, PortForwardingInformationProvider.getStartedRemotePortForwards()
  - getAuthTimeout
```
public Duration getAuthTimeout()
```
    Specified by:
    
    getAuthTimeout in interface Session
    
    Returns:
    
    Timeout value in milliseconds for authentication stage
  - getIdleTimeout
```
public Duration getIdleTimeout()
```
    Specified by:
    
    getIdleTimeout in interface Session
    
    Returns:
    
    Timeout value in milliseconds for communication
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionHelper

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository

Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

Field Summary

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver

Fields inherited from interface org.apache.sshd.common.PropertyResolver

Fields inherited from interface org.apache.sshd.common.session.SessionContext

Constructor Summary

Method Summary

Methods inherited from class org.apache.sshd.common.kex.AbstractKexFactoryManager

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager

Methods inherited from interface org.apache.sshd.common.Closeable

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager

Methods inherited from interface org.apache.sshd.common.kex.KexFactoryManager

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

Methods inherited from interface org.apache.sshd.common.PropertyResolver

Methods inherited from interface org.apache.sshd.common.session.Session

Methods inherited from interface org.apache.sshd.common.session.SessionContext

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

Methods inherited from interface org.apache.sshd.common.session.SessionListenerManager

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesHolder

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager

Field Detail

authStart

idleStart

initialKexProposal

Constructor Detail

SessionHelper

Method Detail

getIoSession

isServerSession

getFactoryManager

getParentPropertyResolver

getProperties

getAttributesCount

getAttribute

attributeKeys

computeAttributeIfAbsent

setAttribute

removeAttribute

clearAttributes

getUsername

setUsername

isAuthenticated

setAuthenticated

checkForTimeouts

getAuthTimeoutStart

resetAuthTimeout

checkAuthenticationTimeout

getIdleTimeoutStart

checkIdleTimeout

resetIdleTimeout

getTimeoutStatus

getReservedSessionMessagesHandler

setReservedSessionMessagesHandler

getSessionDisconnectHandler

setSessionDisconnectHandler

handleIgnore

doInvokeIgnoreMessageHandler

sendNotImplemented

handleUnimplemented

doInvokeUnimplementedMessageHandler

sendDebugMessage

handleDebug

doInvokeDebugMessageHandler

resolveReservedSessionMessagesHandler

getUnknownChannelReferenceHandler

setUnknownChannelReferenceHandler

resolveUnknownChannelReferenceHandler

getChannelStreamWriterResolver

setChannelStreamWriterResolver