Interface ServerSession

All Superinterfaces:

org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.AttributeStore, AutoCloseable, Channel, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, org.apache.sshd.common.Closeable, org.apache.sshd.common.util.net.ConnectionEndpointsIndicator, FactoryManagerHolder, KexExtensionHandlerManager, KexFactoryManager, org.apache.sshd.common.keyprovider.KeyPairProviderHolder, org.apache.sshd.common.auth.MutableUserHolder, PortForwardingEventListenerManager, PortForwardingInformationProvider, org.apache.sshd.common.PropertyResolver, ReservedSessionMessagesManager, ServerAuthenticationManager, Session, org.apache.sshd.common.session.SessionContext, SessionDisconnectHandlerManager, org.apache.sshd.common.session.SessionHeartbeatController, SessionListenerManager, org.apache.sshd.common.signature.SignatureFactoriesHolder, org.apache.sshd.common.signature.SignatureFactoriesManager, UnknownChannelReferenceHandlerManager, org.apache.sshd.common.auth.UserAuthFactoriesManager<ServerSession, UserAuth, UserAuthFactory>, org.apache.sshd.common.auth.UsernameHolder

All Known Implementing Classes:

AbstractServerSession, ServerSessionImpl

public interface ServerSession
extends Session, ServerAuthenticationManager

Author:

Apache MINA SSHD Project

Nested Class Summary

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

org.apache.sshd.common.AttributeRepository.AttributeKey<T>

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

org.apache.sshd.common.session.SessionHeartbeatController.HeartbeatType

Field Summary

Fields inherited from interface ChannelStreamWriterResolver

NONE

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

EMPTY

Fields inherited from interface ServerAuthenticationManager

DEFAULT_USER_AUTH_GSS_FACTORY, DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY, DEFAULT_USER_AUTH_PASSWORD_FACTORY, DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY

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

DEFAULT_SSH_VERSION_PREFIX, FALLBACK_SSH_VERSION_PREFIX, MAX_VERSION_LINE_LENGTH

Method Summary

Modifier and Type	Method	Description
int	getActiveSessionCountForUser(String userName)	Retrieve the current number of sessions active for a given username.
SocketAddress	getClientAddress()
ServerFactoryManager	getFactoryManager()
KeyPair	getHostKey()
org.apache.sshd.common.io.IoWriteFuture	signalAuthenticationSuccess(String username, String authService, org.apache.sshd.common.util.buffer.Buffer buffer)

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 ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface ChannelStreamWriterResolverManager

getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver

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

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Methods inherited from interface KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface KexFactoryManager

getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Methods inherited from interface org.apache.sshd.common.auth.MutableUserHolder

setUsername

Methods inherited from interface PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface PortForwardingInformationProvider

getBoundLocalPortForwards, getBoundRemotePortForward, getLocalForwardsBindings, getRemoteForwardsBindings, getStartedLocalPortForwards, getStartedRemotePortForwards, isLocalPortForwardingStartedForPort, isRemotePortForwardingStartedForPort

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 ReservedSessionMessagesManager

getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface ServerAuthenticationManager

getGSSAuthenticator, getHostBasedAuthenticator, getHostKeyCertificateProvider, getKeyboardInteractiveAuthenticator, getPasswordAuthenticator, getPublickeyAuthenticator, setGSSAuthenticator, setHostBasedAuthenticator, setHostKeyCertificateProvider, setKeyboardInteractiveAuthenticator, setPasswordAuthenticator, setPublickeyAuthenticator, setUserAuthFactoriesNames

Methods inherited from interface Session

createBuffer, createBuffer, disconnect, exceptionCaught, getAuthTimeout, getAuthTimeoutStart, getFilterChain, getIdleTimeout, getIdleTimeoutStart, getIoSession, getLocalAddress, getRemoteAddress, getService, getTimeoutStatus, prepareBuffer, reExchangeKeys, request, request, request, request, resetAuthTimeout, resetIdleTimeout, resolveAttribute, sendDebugMessage, sendIgnoreMessage, setAuthenticated, 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, isAuthenticated, isServerSession

Methods inherited from interface SessionDisconnectHandlerManager

getSessionDisconnectHandler, setSessionDisconnectHandler

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

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface 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

Methods inherited from interface UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Methods inherited from interface org.apache.sshd.common.auth.UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.auth.UsernameHolder

getUsername

Method Details

getFactoryManager

ServerFactoryManager getFactoryManager()

Specified by:

getFactoryManager in interface FactoryManagerHolder

Returns:

The ServerFactoryManager for this session

getClientAddress

SocketAddress getClientAddress()

Returns:

The SocketAddress of the remote client. If no proxy wrapping was used then this is the same as the IoSession#getRemoteAddress(). Otherwise, it indicates the real client's address that was somehow transmitted via the proxy meta-data

getHostKey

KeyPair getHostKey()

Returns:

The KeyPair representing the current session's used keys on KEX - null if not negotiated yet

getActiveSessionCountForUser

int getActiveSessionCountForUser(String userName)

Retrieve the current number of sessions active for a given username.

Parameters:

userName - The name of the user - ignored if null/empty

Returns:

The current number of live SshSession objects associated with the user

signalAuthenticationSuccess

org.apache.sshd.common.io.IoWriteFuture signalAuthenticationSuccess(String username,
 String authService,
 org.apache.sshd.common.util.buffer.Buffer buffer)
                                                             throws Exception

• Marks the session as authenticated.
• Starts the specified service.
• Sends the SSH_MSG_USERAUTH_SUCCESS message.

Parameters:

username - The authenticated username

authService - The service to start

buffer - Any extra data received to use to start the service

Returns:

An IoWriteFuture that can be used to wait for the SSH_MSG_USERAUTH_SUCCESS message send result

Throws:

Exception - if cannot handle the request