Interface FactoryManager

All Superinterfaces:

org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.AttributeStore, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, org.apache.sshd.common.io.IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, PortForwardingEventListenerManager, org.apache.sshd.common.PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, org.apache.sshd.common.session.SessionHeartbeatController, SessionListenerManager, org.apache.sshd.common.signature.SignatureFactoriesHolder, org.apache.sshd.common.signature.SignatureFactoriesManager, UnknownChannelReferenceHandlerManager

All Known Subinterfaces:

ClientFactoryManager, ServerFactoryManager

All Known Implementing Classes:

AbstractFactoryManager, SshClient, SshServer

public interface FactoryManager
extends KexFactoryManager, SessionListenerManager, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, ChannelListenerManager, ChannelStreamWriterResolverManager, UnknownChannelReferenceHandlerManager, PortForwardingEventListenerManager, org.apache.sshd.common.io.IoServiceEventListenerManager, org.apache.sshd.common.AttributeStore, org.apache.sshd.common.session.SessionHeartbeatController

This interface allows retrieving all the NamedFactory used in the SSH protocol.

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

Modifier and Type	Field	Description
static final String	DEFAULT_VERSION	The default REPORTED_VERSION of getVersion() if the built-in version information cannot be accessed

Fields inherited from interface ChannelStreamWriterResolver

NONE

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

EMPTY

Method Summary

Modifier and Type	Method	Description
SshAgentFactory	getAgentFactory()	Retrieve the agent factory for creating SshAgent objects.
default AgentForwardingFilter	getAgentForwardingFilter()
List<? extends ChannelFactory>	getChannelFactories()	Retrieve the list of named factories for Channel objects.
org.apache.sshd.common.file.FileSystemFactory	getFileSystemFactory()	Retrieve the FileSystemFactory to be used to traverse the file system.
ForwarderFactory	getForwarderFactory()	Retrieve the forwarder factory used to support forwarding.
ForwardingFilter	getForwardingFilter()	Retrieve the ForwardingFilter to be used by the SSH server.
List<RequestHandler<ConnectionService>>	getGlobalRequestHandlers()	Retrieve the list of global request handlers.
org.apache.sshd.common.io.IoServiceFactory	getIoServiceFactory()
org.apache.sshd.common.Factory<? extends org.apache.sshd.common.random.Random>	getRandomFactory()	Retrieve the Random factory to be used.
ScheduledExecutorService	getScheduledExecutorService()	Retrieve the ScheduledExecutorService to be used.
List<? extends ServiceFactory>	getServiceFactories()	Retrieve the list of SSH Service factories.
default TcpForwardingFilter	getTcpForwardingFilter()
String	getVersion()	An upper case string identifying the version of the software used on client or server side.
default X11ForwardingFilter	getX11ForwardingFilter()
default <T> T	resolveAttribute(org.apache.sshd.common.AttributeRepository.AttributeKey<T> key)
static <T> T	resolveAttribute(FactoryManager manager, org.apache.sshd.common.AttributeRepository.AttributeKey<T> key)

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.io.IoServiceEventListenerManager

getIoServiceEventListener, setIoServiceEventListener

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 PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

Field Details

DEFAULT_VERSION

static final String DEFAULT_VERSION

The default REPORTED_VERSION of getVersion() if the built-in version information cannot be accessed

See Also:

• Constant Field Values

Method Details

getVersion

String getVersion()

An upper case string identifying the version of the software used on client or server side. This version includes the name and version of the software and usually looks like this: SSHD-CORE-1.0

Returns:

the version of the software

getIoServiceFactory

org.apache.sshd.common.io.IoServiceFactory getIoServiceFactory()

getRandomFactory

org.apache.sshd.common.Factory<? extends org.apache.sshd.common.random.Random> getRandomFactory()

Retrieve the Random factory to be used.

Returns:

The Random factory, never null

getChannelFactories

List<? extends ChannelFactory> getChannelFactories()

Retrieve the list of named factories for Channel objects.

Returns:

A list of ChannelFactory-ies, never null

getAgentFactory

SshAgentFactory getAgentFactory()

Retrieve the agent factory for creating SshAgent objects.

Returns:

The SshAgentFactory

getScheduledExecutorService

ScheduledExecutorService getScheduledExecutorService()

Retrieve the ScheduledExecutorService to be used.

Returns:

The ScheduledExecutorService, never null

getForwardingFilter

ForwardingFilter getForwardingFilter()

Retrieve the ForwardingFilter to be used by the SSH server. If no filter has been configured (i.e. this method returns null), then all forwarding requests will be rejected.

Returns:

The ForwardingFilter or null

getTcpForwardingFilter

default TcpForwardingFilter getTcpForwardingFilter()

getAgentForwardingFilter

default AgentForwardingFilter getAgentForwardingFilter()

getX11ForwardingFilter

default X11ForwardingFilter getX11ForwardingFilter()

getForwarderFactory

ForwarderFactory getForwarderFactory()

Retrieve the forwarder factory used to support forwarding.

Returns:

The ForwarderFactory

getFileSystemFactory

org.apache.sshd.common.file.FileSystemFactory getFileSystemFactory()

Retrieve the FileSystemFactory to be used to traverse the file system.

Returns:

a valid FileSystemFactory instance or null if file based interactions are not supported on this server

getServiceFactories

List<? extends ServiceFactory> getServiceFactories()

Retrieve the list of SSH Service factories.

Returns:

a list of named Service factories, never null

getGlobalRequestHandlers

List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()

Retrieve the list of global request handlers.

Returns:

a list of named GlobalRequestHandler

resolveAttribute

default <T> T resolveAttribute(org.apache.sshd.common.AttributeRepository.AttributeKey<T> key)

Specified by:

resolveAttribute in interface org.apache.sshd.common.AttributeRepository

resolveAttribute

static <T> T resolveAttribute(FactoryManager manager,
 org.apache.sshd.common.AttributeRepository.AttributeKey<T> key)

Type Parameters:

T - The generic attribute type

Parameters:

manager - The FactoryManager - ignored if null

key - The attribute key - never null

Returns:

Associated value - null if not found