Apache Mina SSHD 2.15.0 · org.apache.sshd.common.session.helpers.AbstractConnectionService

Field Summary

Modifier and Type	Field and Description
private final AtomicReference<AgentForwardSupport>	agentForwardHolder
private final AtomicBoolean	allowMoreSessions
protected final Map<Long, Channel>	channels Map of channels keyed by the identifier
public static final String	DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING Used in `SSH_MSH_IGNORE` messages for the keep-alive mechanism
private final AtomicReference<Forwarder>	forwarderHolder
private ScheduledFuture<?>	heartBeat
protected final AtomicLong	heartbeatCount
private final PortForwardingEventListener	listenerProxy
private final Collection<PortForwardingEventListener>	listeners
private final Collection<PortForwardingEventListenerManager>	managersHolder
protected final AtomicLong	nextChannelId Next channel identifier - a UINT32 represented as a long
private final Map<String, Object>	properties
public static final IntUnaryOperator	RESPONSE_BUFFER_GROWTH_FACTOR Default growth factor function used to resize response buffers
private final AbstractSession	sessionInstance
private UnknownChannelReferenceHandler	unknownChannelReferenceHandler
private final AtomicReference<X11ForwardSupport>	x11ForwardHolder

Constructor Summary

Access	Constructor and Description
protected	AbstractConnectionService(AbstractSession session)

Method Summary

Modifier and Type	Method and Description
public void	addPortForwardingEventListener(PortForwardingEventListener The `PortForwardingEventListener` to add - never `null` listener) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.addPortForwardingEventListener. Add a port forwarding listener
public boolean	addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.addPortForwardingEventListenerManager.
public void	channelClose(Buffer the buffer containing the packet buffer) Close a channel due to a close packet received
public void	channelData(Buffer the buffer containing the data buffer) Process incoming data on a channel
public void	channelEof(Buffer the buffer containing the packet buffer) Process end of file on a channel
public void	channelExtendedData(Buffer the buffer containing the data buffer) Process incoming extended data on a channel
public void	channelFailure(Buffer the buffer containing the packet buffer) Process a failure on a channel
protected void	channelOpen(Buffer buffer)
public void	channelOpenConfirmation(Buffer buffer)
public void	channelOpenFailure(Buffer buffer)
public void	channelRequest(Buffer the buffer containing the request buffer) Service a request on a channel
public void	channelSuccess(Buffer the buffer containing the packet buffer) Process a success on a channel
public void	channelWindowAdjust(Buffer the buffer containing the window adjustment parameters buffer) Process a window adjust packet on a channel
protected AgentForwardSupport	createAgentForwardSupport(Session session)
protected Forwarder	createForwardingFilter(Session session)
protected X11ForwardSupport	createX11ForwardSupport(Session session)
protected void	futureDone(HasException future)
public AgentForwardSupport	getAgentForwardSupport() Implements org.apache.sshd.common.session.ConnectionService.getAgentForwardSupport.
protected Channel	Returns: the target channel getChannel(byte The command being processed for the channel cmd, Buffer the incoming packet buffer) Retrieve the channel designated by the given packet
protected Channel	getChannel(byte cmd, long recipient, Buffer buffer)
public Collection<Channel>	getChannels()
public Forwarder	getForwarder() Implements org.apache.sshd.common.session.ConnectionService.getForwarder. Retrieve the forwarder instance
protected Closeable	getInnerCloseable() Implements abstract org.apache.sshd.common.util.closeable.AbstractInnerCloseable.getInnerCloseable.
protected long	getNextChannelId()
public PortForwardingEventListener	getPortForwardingEventListenerProxy() Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.getPortForwardingEventListenerProxy.
public Map<String, Object>	getProperties() Implements org.apache.sshd.common.PropertyResolver.getProperties. A map of properties that can be used to configure the SSH server or client.
public Collection<PortForwardingEventListenerManager>	getRegisteredManagers() Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.getRegisteredManagers.
public AbstractSession	getSession() Implements org.apache.sshd.common.session.SessionHolder.getSession.
public UnknownChannelReferenceHandler	getUnknownChannelReferenceHandler() Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler.
public X11ForwardSupport	getX11ForwardSupport() Implements org.apache.sshd.common.session.ConnectionService.getX11ForwardSupport.
protected IoWriteFuture	Returns: An `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" globalRequest(Buffer The request `Buffer` buffer) Process global requests
protected IoWriteFuture	handleUnknownRequest(Buffer buffer, String req, boolean wantReply)
public boolean	isAllowMoreSessions() Implements org.apache.sshd.common.session.ConnectionService.isAllowMoreSessions.
protected void	preClose() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose. preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
public void	process(int The incoming command type cmd, Buffer The `Buffer` containing optional command parameters buffer) Implements org.apache.sshd.common.Service.process. Service the request.
public long	registerChannel(Channel The `Channel` to register channel) Implements org.apache.sshd.common.session.ConnectionService.registerChannel. Register a newly created channel with a new unique identifier
public void	removePortForwardingEventListener(PortForwardingEventListener The `PortForwardingEventListener` to remove - ignored if `null` listener) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.removePortForwardingEventListener. Remove a port forwarding listener
public boolean	removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.removePortForwardingEventListenerManager.
protected void	requestFailure(Buffer buffer)
protected void	requestSuccess(Buffer buffer)
public UnknownChannelReferenceHandler	resolveUnknownChannelReferenceHandler() Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.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, long sender, int reasonCode, String message, String lang)
protected IoWriteFuture	sendGlobalResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply)
protected boolean	Returns: `true` if heartbeat successfully sent sendHeartBeat() Sends a heartbeat message/packet
public void	setAllowMoreSessions(boolean allow) Implements org.apache.sshd.common.session.ConnectionService.setAllowMoreSessions.
public void	setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler The `UnknownChannelReferenceHandlerManager` to use - if `null` then any reference to unknown channel causes an `SshChannelNotFoundException` handler) Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.setUnknownChannelReferenceHandler.
public void	start() Implements org.apache.sshd.common.Service.start.
protected synchronized ScheduledFuture<?>	startHeartBeat()
protected synchronized void	stopHeartBeat()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	unregisterChannel(Channel the channel channel) Implements org.apache.sshd.common.session.ConnectionService.unregisterChannel. Remove this channel from the list of managed channels

Inherited from org.apache.sshd.common.util.closeable.AbstractInnerCloseable:: doCloseGracefully doCloseImmediately

Field Detail

agentForwardHolder	back to summary
private final AtomicReference<AgentForwardSupport> agentForwardHolder

allowMoreSessions	back to summary
private final AtomicBoolean allowMoreSessions

channels	back to summary
protected final Map<Long, Channel> channels Map of channels keyed by the identifier

DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING	back to summary
public static final String DEFAULT_SESSION_IGNORE_HEARTBEAT_STRING Used in `SSH_MSH_IGNORE` messages for the keep-alive mechanism

forwarderHolder	back to summary
private final AtomicReference<Forwarder> forwarderHolder

heartBeat	back to summary
private ScheduledFuture<?> heartBeat

heartbeatCount	back to summary
protected final AtomicLong heartbeatCount

listenerProxy	back to summary
private final PortForwardingEventListener listenerProxy

listeners	back to summary
private final Collection<PortForwardingEventListener> listeners

managersHolder	back to summary
private final Collection<PortForwardingEventListenerManager> managersHolder

nextChannelId	back to summary
protected final AtomicLong nextChannelId Next channel identifier - a UINT32 represented as a long

properties	back to summary
private final Map<String, Object> properties

RESPONSE_BUFFER_GROWTH_FACTOR	back to summary
public static final IntUnaryOperator RESPONSE_BUFFER_GROWTH_FACTOR Default growth factor function used to resize response buffers

sessionInstance	back to summary
private final AbstractSession sessionInstance

unknownChannelReferenceHandler	back to summary
private UnknownChannelReferenceHandler unknownChannelReferenceHandler

x11ForwardHolder	back to summary
private final AtomicReference<X11ForwardSupport> x11ForwardHolder

Constructor Detail

AbstractConnectionService	back to summary
protected AbstractConnectionService(AbstractSession session)

Method Detail

addPortForwardingEventListener back to summary

addPortForwardingEventListener	back to summary
public void addPortForwardingEventListener(PortForwardingEventListener listener) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.addPortForwardingEventListener. Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManager.addPortForwardingEventListener. Add a port forwarding listener Parameters listener:PortForwardingEventListener The `PortForwardingEventListener` to add - never `null` Annotations @Override

public void addPortForwardingEventListener(PortForwardingEventListener listener)

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.addPortForwardingEventListener.

Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManager.addPortForwardingEventListener.

Add a port forwarding listener

Parameters

listener:PortForwardingEventListener: The PortForwardingEventListener to add - never null

Annotations

@Override

addPortForwardingEventListenerManager	back to summary
public boolean addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager) Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.addPortForwardingEventListenerManager. Annotations @Override

addPortForwardingEventListenerManager

back to summary

public boolean addPortForwardingEventListenerManager(PortForwardingEventListenerManager manager)

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.addPortForwardingEventListenerManager.

Annotations

@Override

channelClose	back to summary
public void channelClose(Buffer buffer) throws IOException Close a channel due to a close packet received Parameters buffer:Buffer the buffer containing the packet Exceptions IOException: if an error occurs

channelClose

back to summary

public void channelClose(Buffer buffer) throws IOException

Close a channel due to a close packet received

Parameters

buffer:Buffer: the buffer containing the packet

Exceptions

IOException:: if an error occurs

channelData	back to summary
public void channelData(Buffer buffer) throws IOException Process incoming data on a channel Parameters buffer:Buffer the buffer containing the data Exceptions IOException: if an error occurs

channelData

back to summary

public void channelData(Buffer buffer) throws IOException

Process incoming data on a channel

Parameters

buffer:Buffer: the buffer containing the data

Exceptions

IOException:: if an error occurs

channelEof	back to summary
public void channelEof(Buffer buffer) throws IOException Process end of file on a channel Parameters buffer:Buffer the buffer containing the packet Exceptions IOException: if an error occurs

channelEof

back to summary

public void channelEof(Buffer buffer) throws IOException

Process end of file on a channel

Parameters

buffer:Buffer: the buffer containing the packet

Exceptions

IOException:: if an error occurs

channelExtendedData	back to summary
public void channelExtendedData(Buffer buffer) throws IOException Process incoming extended data on a channel Parameters buffer:Buffer the buffer containing the data Exceptions IOException: if an error occurs

channelExtendedData

back to summary

public void channelExtendedData(Buffer buffer) throws IOException

Process incoming extended data on a channel

Parameters

buffer:Buffer: the buffer containing the data

Exceptions

IOException:: if an error occurs

channelFailure	back to summary
public void channelFailure(Buffer buffer) throws IOException Process a failure on a channel Parameters buffer:Buffer the buffer containing the packet Exceptions IOException: if an error occurs

channelFailure

back to summary

public void channelFailure(Buffer buffer) throws IOException

Process a failure on a channel

Parameters

buffer:Buffer: the buffer containing the packet

Exceptions

IOException:: if an error occurs

channelOpen	back to summary
protected void channelOpen(Buffer buffer) throws Exception

channelOpenConfirmation	back to summary
public void channelOpenConfirmation(Buffer buffer) throws IOException

channelOpenFailure	back to summary
public void channelOpenFailure(Buffer buffer) throws IOException

channelRequest	back to summary
public void channelRequest(Buffer buffer) throws IOException Service a request on a channel Parameters buffer:Buffer the buffer containing the request Exceptions IOException: if an error occurs

channelRequest

back to summary

public void channelRequest(Buffer buffer) throws IOException

Service a request on a channel

Parameters

buffer:Buffer: the buffer containing the request

Exceptions

IOException:: if an error occurs

channelSuccess	back to summary
public void channelSuccess(Buffer buffer) throws IOException Process a success on a channel Parameters buffer:Buffer the buffer containing the packet Exceptions IOException: if an error occurs

channelSuccess

back to summary

public void channelSuccess(Buffer buffer) throws IOException

Process a success on a channel

Parameters

buffer:Buffer: the buffer containing the packet

Exceptions

IOException:: if an error occurs

channelWindowAdjust	back to summary
public void channelWindowAdjust(Buffer buffer) throws IOException Process a window adjust packet on a channel Parameters buffer:Buffer the buffer containing the window adjustment parameters Exceptions IOException: if an error occurs

channelWindowAdjust

back to summary

public void channelWindowAdjust(Buffer buffer) throws IOException

Process a window adjust packet on a channel

Parameters

buffer:Buffer: the buffer containing the window adjustment parameters

Exceptions

IOException:: if an error occurs

createAgentForwardSupport	back to summary
protected AgentForwardSupport createAgentForwardSupport(Session session)

createForwardingFilter	back to summary
protected Forwarder createForwardingFilter(Session session)

createX11ForwardSupport	back to summary
protected X11ForwardSupport createX11ForwardSupport(Session session)

futureDone	back to summary
protected void futureDone(HasException future)

getAgentForwardSupport	back to summary
public AgentForwardSupport getAgentForwardSupport() Implements org.apache.sshd.common.session.ConnectionService.getAgentForwardSupport. Annotations @Override

getAgentForwardSupport

back to summary

public AgentForwardSupport getAgentForwardSupport()

Implements org.apache.sshd.common.session.ConnectionService.getAgentForwardSupport.

Annotations

@Override

getChannel	back to summary
protected Channel getChannel(byte cmd, Buffer buffer) throws IOException Retrieve the channel designated by the given packet Parameters cmd:byte The command being processed for the channel buffer:Buffer the incoming packet Returns:Channel the target channel Exceptions IOException: if the channel does not exists

getChannel

back to summary

protected Channel getChannel(byte cmd, Buffer buffer) throws IOException

Retrieve the channel designated by the given packet

Parameters

cmd:byte: The command being processed for the channel
buffer:Buffer: the incoming packet

Returns:Channel

the target channel

Exceptions

IOException:: if the channel does not exists

getChannel	back to summary
protected Channel getChannel(byte cmd, long recipient, Buffer buffer) throws IOException

getChannels	back to summary
public Collection<Channel> getChannels()

getForwarder back to summary

getForwarder	back to summary
public Forwarder getForwarder() Implements org.apache.sshd.common.session.ConnectionService.getForwarder. Doc from org.apache.sshd.common.session.ConnectionService.getForwarder. Retrieve the forwarder instance Returns:Forwarder The `Forwarder` Annotations @Override

public Forwarder getForwarder()

Implements org.apache.sshd.common.session.ConnectionService.getForwarder.

Doc from org.apache.sshd.common.session.ConnectionService.getForwarder.

Retrieve the forwarder instance

Returns:Forwarder

The Forwarder

Annotations

@Override

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Implements abstract org.apache.sshd.common.util.closeable.AbstractInnerCloseable.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Implements abstract org.apache.sshd.common.util.closeable.AbstractInnerCloseable.getInnerCloseable.

Annotations

@Override

getNextChannelId	back to summary
protected long getNextChannelId()

getPortForwardingEventListenerProxy	back to summary
public PortForwardingEventListener getPortForwardingEventListenerProxy() Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.getPortForwardingEventListenerProxy. Returns:PortForwardingEventListener Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManager.getPortForwardingEventListenerProxy. A proxy listener representing all the currently registered listener through this manager Annotations @Override

getPortForwardingEventListenerProxy

back to summary

public PortForwardingEventListener getPortForwardingEventListenerProxy()

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.getPortForwardingEventListenerProxy.

Returns:PortForwardingEventListener

Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManager.getPortForwardingEventListenerProxy.

A proxy listener representing all the currently registered listener through this manager

Annotations

@Override

getProperties back to summary

getProperties	back to summary
public Map<String, Object> getProperties() Implements org.apache.sshd.common.PropertyResolver.getProperties. Doc from org.apache.sshd.common.PropertyResolver.getProperties. 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. Returns:Map<String, Object> a valid `Map` containing configuration values, never `null` Note may be immutable. Annotations @Override

public Map<String, Object> getProperties()

Implements org.apache.sshd.common.PropertyResolver.getProperties.

Doc from org.apache.sshd.common.PropertyResolver.getProperties.

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.

Returns:Map<String, Object>

a valid Map containing configuration values, never null

Note

may be immutable.

Annotations

@Override

getRegisteredManagers	back to summary
public Collection<PortForwardingEventListenerManager> getRegisteredManagers() Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.getRegisteredManagers. Returns:Collection<PortForwardingEventListenerManager> Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.getRegisteredManagers. The currently registered managers Note it is highly recommended that implementors return either an un-modifiable collection or a copy of the current one. Callers, should avoid modifying the retrieved value. Annotations @Override

getRegisteredManagers

back to summary

public Collection<PortForwardingEventListenerManager> getRegisteredManagers()

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.getRegisteredManagers.

Returns:Collection<PortForwardingEventListenerManager>

Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.getRegisteredManagers.

The currently registered managers

Note

it is highly recommended that implementors return either an un-modifiable collection or a copy of the current one. Callers, should avoid modifying the retrieved value.

Annotations

@Override

getSession	back to summary
public AbstractSession getSession() Implements org.apache.sshd.common.session.SessionHolder.getSession. Annotations @Override

getSession

back to summary

public AbstractSession getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations

@Override

getUnknownChannelReferenceHandler back to summary

getUnknownChannelReferenceHandler	back to summary
public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler() Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler. Returns:UnknownChannelReferenceHandler Doc from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler. The `UnknownChannelReferenceHandlerManager` to use - if `null` then any reference to unknown channel causes an `SshChannelNotFoundException` Annotations @Override

public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()

Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler.

Returns:UnknownChannelReferenceHandler

Doc from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.getUnknownChannelReferenceHandler.

The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

Annotations

@Override

getX11ForwardSupport	back to summary
public X11ForwardSupport getX11ForwardSupport() Implements org.apache.sshd.common.session.ConnectionService.getX11ForwardSupport. Annotations @Override

getX11ForwardSupport

back to summary

public X11ForwardSupport getX11ForwardSupport()

Implements org.apache.sshd.common.session.ConnectionService.getX11ForwardSupport.

Annotations

@Override

globalRequest back to summary

protected IoWriteFuture globalRequest(Buffer buffer) throws Exception

Process global requests

Parameters

buffer:Buffer: The request Buffer

Returns:IoWriteFuture

An 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"

Exceptions

Exception:: If failed to process the request

handleUnknownRequest	back to summary
protected IoWriteFuture handleUnknownRequest(Buffer buffer, String req, boolean wantReply) throws IOException

isAllowMoreSessions

back to summary

public boolean isAllowMoreSessions()

Implements org.apache.sshd.common.session.ConnectionService.isAllowMoreSessions.

Annotations

@Override

preClose

back to summary

protected void preClose()

Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose.

Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.preClose.

preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

Annotations

@Override

process back to summary

public void process(int cmd, Buffer buffer) throws Exception

Implements org.apache.sshd.common.Service.process.

Doc from org.apache.sshd.common.Service.process.

Service the request.

Parameters

cmd:int: The incoming command type
buffer:Buffer: The Buffer containing optional command parameters

Annotations

@Override

Exceptions

Exception:: If failed to process the command

registerChannel back to summary

public long registerChannel(Channel channel) throws IOException

Implements org.apache.sshd.common.session.ConnectionService.registerChannel.

Doc from org.apache.sshd.common.session.ConnectionService.registerChannel.

Parameters

channel:Channel: The Channel to register

Returns:long

The assigned id of this channel - a UINT32 represented as a long

Annotations

@Override

Exceptions

IOException:: If failed to initialize and register the channel

removePortForwardingEventListener back to summary

public void removePortForwardingEventListener(PortForwardingEventListener listener)

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManager.removePortForwardingEventListener.

Doc from org.apache.sshd.common.forward.PortForwardingEventListenerManager.removePortForwardingEventListener.

Remove a port forwarding listener

Parameters

listener:PortForwardingEventListener: The PortForwardingEventListener to remove - ignored if null

Annotations

@Override

removePortForwardingEventListenerManager

back to summary

public boolean removePortForwardingEventListenerManager(PortForwardingEventListenerManager manager)

Implements org.apache.sshd.common.forward.PortForwardingEventListenerManagerHolder.removePortForwardingEventListenerManager.

Annotations

@Override

requestFailure	back to summary
protected void requestFailure(Buffer buffer) throws Exception

requestSuccess	back to summary
protected void requestSuccess(Buffer buffer) throws Exception

resolveUnknownChannelReferenceHandler

back to summary

public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()

Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.resolveUnknownChannelReferenceHandler.

Doc from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.resolveUnknownChannelReferenceHandler.

Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)

Returns:UnknownChannelReferenceHandler

The resolved handler instance

Annotations

@Override

sendChannelOpenFailure	back to summary
protected IoWriteFuture sendChannelOpenFailure(Buffer buffer, long sender, int reasonCode, String message, String lang) throws IOException

sendGlobalResponse	back to summary
protected IoWriteFuture sendGlobalResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply) throws IOException

sendHeartBeat back to summary

protected boolean sendHeartBeat()

Sends a heartbeat message/packet

Returns:boolean: true if heartbeat successfully sent

setAllowMoreSessions

back to summary

public void setAllowMoreSessions(boolean allow)

Implements org.apache.sshd.common.session.ConnectionService.setAllowMoreSessions.

Annotations

@Override

setUnknownChannelReferenceHandler back to summary

public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler handler)

Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.setUnknownChannelReferenceHandler.

Parameters

handler:UnknownChannelReferenceHandler

Doc from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.setUnknownChannelReferenceHandler.

The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

Annotations

@Override

start

back to summary

public void start()

Implements org.apache.sshd.common.Service.start.

Annotations

@Override

startHeartBeat	back to summary
protected synchronized ScheduledFuture<?> startHeartBeat()

stopHeartBeat	back to summary
protected synchronized void stopHeartBeat()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

unregisterChannel

back to summary

public void unregisterChannel(Channel channel)

Implements org.apache.sshd.common.session.ConnectionService.unregisterChannel.

Remove this channel from the list of managed channels

Parameters

channel:Channel: the channel

Annotations

@Override

public abstract Class AbstractConnectionService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail