public abstract class AbstractConnectionService extends AbstractInnerCloseable implements ConnectionService
AbstractCloseable.State
SessionHeartbeatController.HeartbeatType
Modifier and Type | Field and Description |
---|---|
private java.util.concurrent.atomic.AtomicReference<AgentForwardSupport> |
agentForwardHolder |
private java.util.concurrent.atomic.AtomicBoolean |
allowMoreSessions |
protected java.util.Map<java.lang.Integer,Channel> |
channels
Map of channels keyed by the identifier
|
static int |
DEFAULT_MAX_CHANNELS
Default value for
MAX_CONCURRENT_CHANNELS_PROP is none specified |
static java.lang.String |
DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING
Used in
SSH_MSH_IGNORE messages for the keep-alive mechanism |
private java.util.concurrent.atomic.AtomicReference<ForwardingFilter> |
forwarderHolder |
private java.util.concurrent.ScheduledFuture<?> |
heartBeat |
protected java.util.concurrent.atomic.AtomicLong |
heartbeatCount |
private PortForwardingEventListener |
listenerProxy |
private java.util.Collection<PortForwardingEventListener> |
listeners |
private java.util.Collection<PortForwardingEventListenerManager> |
managersHolder |
static java.lang.String |
MAX_CONCURRENT_CHANNELS_PROP
Property that can be used to configure max.
|
protected java.util.concurrent.atomic.AtomicInteger |
nextChannelId
Next channel identifier
|
private java.util.Map<java.lang.String,java.lang.Object> |
properties |
static java.util.function.IntUnaryOperator |
RESPONSE_BUFFER_GROWTH_FACTOR
Default growth factor function used to resize response buffers
|
private AbstractSession |
sessionInstance |
private UnknownChannelReferenceHandler |
unknownChannelReferenceHandler |
private java.util.concurrent.atomic.AtomicReference<X11ForwardSupport> |
x11ForwardHolder |
closeFuture, futureLock, state
log
CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT
DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE
EMPTY
Modifier | Constructor and Description |
---|---|
protected |
AbstractConnectionService(AbstractSession session) |
Modifier and Type | Method and Description |
---|---|
void |
addPortForwardingEventListener(PortForwardingEventListener listener)
Add a port forwarding listener
|
boolean |
addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager) |
void |
channelClose(Buffer buffer)
Close a channel due to a close packet received
|
void |
channelData(Buffer buffer)
Process incoming data on a channel
|
void |
channelEof(Buffer buffer)
Process end of file on a channel
|
void |
channelExtendedData(Buffer buffer)
Process incoming extended data on a channel
|
void |
channelFailure(Buffer buffer)
Process a failure on a channel
|
protected void |
channelOpen(Buffer buffer) |
void |
channelOpenConfirmation(Buffer buffer) |
void |
channelOpenFailure(Buffer buffer) |
void |
channelRequest(Buffer buffer)
Service a request on a channel
|
void |
channelSuccess(Buffer buffer)
Process a success on a channel
|
void |
channelWindowAdjust(Buffer buffer)
Process a window adjust packet on a channel
|
protected AgentForwardSupport |
createAgentForwardSupport(Session session) |
protected ForwardingFilter |
createForwardingFilter(Session session) |
protected X11ForwardSupport |
createX11ForwardSupport(Session session) |
protected void |
futureDone(IoWriteFuture future) |
AgentForwardSupport |
getAgentForwardSupport() |
protected Channel |
getChannel(byte cmd,
Buffer buffer)
Retrieve the channel designated by the given packet
|
protected Channel |
getChannel(byte cmd,
int recipient,
Buffer buffer) |
java.util.Collection<Channel> |
getChannels() |
ForwardingFilter |
getForwardingFilter()
Retrieve the forwarder instance
|
protected Closeable |
getInnerCloseable() |
protected int |
getNextChannelId() |
PortForwardingEventListener |
getPortForwardingEventListenerProxy() |
java.util.Map<java.lang.String,java.lang.Object> |
getProperties()
A map of properties that can be used to configure the SSH server or client.
|
java.util.Collection<PortForwardingEventListenerManager> |
getRegisteredManagers() |
AbstractSession |
getSession() |
UnknownChannelReferenceHandler |
getUnknownChannelReferenceHandler() |
X11ForwardSupport |
getX11ForwardSupport() |
protected IoWriteFuture |
globalRequest(Buffer buffer)
Process global requests
|
protected void |
handleChannelRegistrationFailure(Channel channel,
int channelId) |
protected IoWriteFuture |
handleUnknownRequest(Buffer buffer,
java.lang.String req,
boolean wantReply) |
boolean |
isAllowMoreSessions() |
protected void |
preClose()
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
|
void |
process(int cmd,
Buffer buffer)
Service the request.
|
int |
registerChannel(Channel channel)
Register a newly created channel with a new unique identifier
|
void |
removePortForwardingEventListener(PortForwardingEventListener listener)
Remove a port forwarding listener
|
boolean |
removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager) |
protected void |
requestFailure(Buffer buffer) |
protected void |
requestSuccess(Buffer buffer) |
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)
|
protected IoWriteFuture |
sendChannelOpenFailure(Buffer buffer,
int sender,
int reasonCode,
java.lang.String message,
java.lang.String lang) |
protected IoWriteFuture |
sendGlobalResponse(Buffer buffer,
java.lang.String req,
RequestHandler.Result result,
boolean wantReply) |
protected boolean |
sendHeartBeat()
Sends a heartbeat message/packet
|
void |
setAllowMoreSessions(boolean allow) |
void |
setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler handler) |
void |
start() |
protected java.util.concurrent.ScheduledFuture<?> |
startHeartBeat() |
protected void |
stopHeartBeat() |
java.lang.String |
toString() |
void |
unregisterChannel(Channel channel)
Remove this channel from the list of managed channels
|
doCloseGracefully, doCloseImmediately
addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener
getSimplifiedLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getParentPropertyResolver
getSessionContext
addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener
disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty
public static final java.lang.String MAX_CONCURRENT_CHANNELS_PROP
registerChannel(Channel)
,
Constant Field Valuespublic static final int DEFAULT_MAX_CHANNELS
MAX_CONCURRENT_CHANNELS_PROP
is none specifiedpublic static final java.util.function.IntUnaryOperator RESPONSE_BUFFER_GROWTH_FACTOR
public static final java.lang.String DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING
SSH_MSH_IGNORE
messages for the keep-alive mechanismprotected final java.util.Map<java.lang.Integer,Channel> channels
protected final java.util.concurrent.atomic.AtomicInteger nextChannelId
protected final java.util.concurrent.atomic.AtomicLong heartbeatCount
private java.util.concurrent.ScheduledFuture<?> heartBeat
private final java.util.concurrent.atomic.AtomicReference<AgentForwardSupport> agentForwardHolder
private final java.util.concurrent.atomic.AtomicReference<X11ForwardSupport> x11ForwardHolder
private final java.util.concurrent.atomic.AtomicReference<ForwardingFilter> forwarderHolder
private final java.util.concurrent.atomic.AtomicBoolean allowMoreSessions
private final java.util.Collection<PortForwardingEventListener> listeners
private final java.util.Collection<PortForwardingEventListenerManager> managersHolder
private final java.util.Map<java.lang.String,java.lang.Object> properties
private final PortForwardingEventListener listenerProxy
private final AbstractSession sessionInstance
private UnknownChannelReferenceHandler unknownChannelReferenceHandler
protected AbstractConnectionService(AbstractSession session)
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
PropertyResolver
A 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, the toString()
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 a
long
then it will be parsed into one. Also, if the mapped value is an Integer
but a long
is expected, then it will be converted into one.
getProperties
in interface PropertyResolver
Map
containing configuration values, never null
. Note: may be
immutable.public PortForwardingEventListener getPortForwardingEventListenerProxy()
getPortForwardingEventListenerProxy
in interface PortForwardingEventListenerManager
public void addPortForwardingEventListener(PortForwardingEventListener listener)
PortForwardingEventListenerManager
addPortForwardingEventListener
in interface PortForwardingEventListenerManager
listener
- The PortForwardingEventListener
to add - never null
public void removePortForwardingEventListener(PortForwardingEventListener listener)
PortForwardingEventListenerManager
removePortForwardingEventListener
in interface PortForwardingEventListenerManager
listener
- The PortForwardingEventListener
to remove - ignored if null
public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()
getUnknownChannelReferenceHandler
in interface UnknownChannelReferenceHandlerManager
UnknownChannelReferenceHandlerManager
to use - if null
then any reference to unknown
channel causes an SshChannelNotFoundException
public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)
setUnknownChannelReferenceHandler
in interface UnknownChannelReferenceHandlerManager
handler
- The UnknownChannelReferenceHandlerManager
to use - if null
then any reference to
unknown channel causes an SshChannelNotFoundException
public java.util.Collection<PortForwardingEventListenerManager> getRegisteredManagers()
getRegisteredManagers
in interface PortForwardingEventListenerManagerHolder
public boolean addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager)
addPortForwardingEventListenerManager
in interface PortForwardingEventListenerManagerHolder
public boolean removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager)
removePortForwardingEventListenerManager
in interface PortForwardingEventListenerManagerHolder
public java.util.Collection<Channel> getChannels()
public AbstractSession getSession()
getSession
in interface SessionHolder<Session>
protected java.util.concurrent.ScheduledFuture<?> startHeartBeat()
protected boolean sendHeartBeat()
true
if heartbeat successfully sentprotected void futureDone(IoWriteFuture future)
protected void stopHeartBeat()
public ForwardingFilter getForwardingFilter()
ConnectionService
getForwardingFilter
in interface ConnectionService
ForwardingFilter
protected void preClose()
AbstractCloseable
preClose
in class AbstractCloseable
protected ForwardingFilter createForwardingFilter(Session session)
public X11ForwardSupport getX11ForwardSupport()
getX11ForwardSupport
in interface ConnectionService
protected X11ForwardSupport createX11ForwardSupport(Session session)
public AgentForwardSupport getAgentForwardSupport()
getAgentForwardSupport
in interface ConnectionService
protected AgentForwardSupport createAgentForwardSupport(Session session)
protected Closeable getInnerCloseable()
getInnerCloseable
in class AbstractInnerCloseable
protected int getNextChannelId()
public int registerChannel(Channel channel) throws java.io.IOException
ConnectionService
registerChannel
in interface ConnectionService
channel
- The Channel
to registerjava.io.IOException
- If failed to initialize and register the channelprotected void handleChannelRegistrationFailure(Channel channel, int channelId) throws java.io.IOException
java.io.IOException
public void unregisterChannel(Channel channel)
unregisterChannel
in interface ConnectionService
channel
- the channelpublic void process(int cmd, Buffer buffer) throws java.lang.Exception
Service
public boolean isAllowMoreSessions()
isAllowMoreSessions
in interface ConnectionService
public void setAllowMoreSessions(boolean allow)
setAllowMoreSessions
in interface ConnectionService
public void channelOpenConfirmation(Buffer buffer) throws java.io.IOException
java.io.IOException
public void channelOpenFailure(Buffer buffer) throws java.io.IOException
java.io.IOException
public void channelData(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the datajava.io.IOException
- if an error occurspublic void channelExtendedData(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the datajava.io.IOException
- if an error occurspublic void channelWindowAdjust(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the window adjustment parametersjava.io.IOException
- if an error occurspublic void channelEof(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the packetjava.io.IOException
- if an error occurspublic void channelClose(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the packetjava.io.IOException
- if an error occurspublic void channelRequest(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the requestjava.io.IOException
- if an error occurspublic void channelFailure(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the packetjava.io.IOException
- if an error occurspublic void channelSuccess(Buffer buffer) throws java.io.IOException
buffer
- the buffer containing the packetjava.io.IOException
- if an error occursprotected Channel getChannel(byte cmd, Buffer buffer) throws java.io.IOException
cmd
- The command being processed for the channelbuffer
- the incoming packetjava.io.IOException
- if the channel does not existsprotected Channel getChannel(byte cmd, int recipient, Buffer buffer) throws java.io.IOException
java.io.IOException
public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()
UnknownChannelReferenceHandlerManager
resolveUnknownChannelReferenceHandler
in interface UnknownChannelReferenceHandlerManager
protected void channelOpen(Buffer buffer) throws java.lang.Exception
java.lang.Exception
protected IoWriteFuture sendChannelOpenFailure(Buffer buffer, int sender, int reasonCode, java.lang.String message, java.lang.String lang) throws java.io.IOException
java.io.IOException
protected IoWriteFuture globalRequest(Buffer buffer) throws java.lang.Exception
buffer
- The request Buffer
IoWriteFuture
representing the sent packet - Note: if no reply sent then an
"empty" future is returned - i.e., any added listeners are triggered immediately with
a synthetic "success"java.lang.Exception
- If failed to process the requestprotected IoWriteFuture handleUnknownRequest(Buffer buffer, java.lang.String req, boolean wantReply) throws java.io.IOException
java.io.IOException
protected IoWriteFuture sendGlobalResponse(Buffer buffer, java.lang.String req, RequestHandler.Result result, boolean wantReply) throws java.io.IOException
java.io.IOException
protected void requestSuccess(Buffer buffer) throws java.lang.Exception
java.lang.Exception
protected void requestFailure(Buffer buffer) throws java.lang.Exception
java.lang.Exception
public java.lang.String toString()
toString
in class java.lang.Object