Package org.apache.sshd.common
Interface FactoryManager
-
- All Superinterfaces:
AttributeRepository,AttributeStore,ChannelListenerManager,ChannelStreamWriterResolver,ChannelStreamWriterResolverManager,IoServiceEventListenerManager,KexExtensionHandlerManager,KexFactoryManager,PortForwardingEventListenerManager,PropertyResolver,ReservedSessionMessagesManager,SessionDisconnectHandlerManager,SessionHeartbeatController,SessionListenerManager,SignatureFactoriesHolder,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, IoServiceEventListenerManager, AttributeStore, SessionHeartbeatController
This interface allows retrieving all theNamedFactoryused in the SSH protocol.- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
-
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 static StringDEFAULT_VERSIONThe defaultREPORTED_VERSIONofgetVersion()if the built-in version information cannot be accessed-
Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver
NONE
-
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SshAgentFactorygetAgentFactory()Retrieve the agent factory for creatingSshAgentobjects.default AgentForwardingFiltergetAgentForwardingFilter()List<? extends ChannelFactory>getChannelFactories()Retrieve the list of named factories forChannelobjects.FileSystemFactorygetFileSystemFactory()Retrieve theFileSystemFactoryto be used to traverse the file system.ForwarderFactorygetForwarderFactory()Retrieve the forwarder factory used to support forwarding.ForwardingFiltergetForwardingFilter()Retrieve theForwardingFilterto be used by the SSH server.List<RequestHandler<ConnectionService>>getGlobalRequestHandlers()Retrieve the list of global request handlers.IoServiceFactorygetIoServiceFactory()Factory<? extends Random>getRandomFactory()Retrieve theRandomfactory to be used.ScheduledExecutorServicegetScheduledExecutorService()Retrieve theScheduledExecutorServiceto be used.List<? extends ServiceFactory>getServiceFactories()Retrieve the list of SSHServicefactories.default TcpForwardingFiltergetTcpForwardingFilter()StringgetVersion()An upper case string identifying the version of the software used on client or server side.default X11ForwardingFiltergetX11ForwardingFilter()default <T> TresolveAttribute(AttributeRepository.AttributeKey<T> key)static <T> TresolveAttribute(FactoryManager manager, 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 org.apache.sshd.common.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListener
-
Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager
getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolver
-
Methods inherited from interface org.apache.sshd.common.io.IoServiceEventListenerManager
getIoServiceEventListener, setIoServiceEventListener
-
Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager
getKexExtensionHandler, setKexExtensionHandler
-
Methods inherited from interface org.apache.sshd.common.kex.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.forward.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 org.apache.sshd.common.session.ReservedSessionMessagesManager
getReservedSessionMessagesHandler, setReservedSessionMessagesHandler
-
Methods inherited from interface org.apache.sshd.common.session.SessionDisconnectHandlerManager
getSessionDisconnectHandler, setSessionDisconnectHandler
-
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
-
Methods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
-
-
-
-
Field Detail
-
DEFAULT_VERSION
static final String DEFAULT_VERSION
The defaultREPORTED_VERSIONofgetVersion()if the built-in version information cannot be accessed- See Also:
- Constant Field Values
-
-
Method Detail
-
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
IoServiceFactory getIoServiceFactory()
-
getRandomFactory
Factory<? extends Random> getRandomFactory()
Retrieve theRandomfactory to be used.- Returns:
- The
Randomfactory, nevernull
-
getChannelFactories
List<? extends ChannelFactory> getChannelFactories()
Retrieve the list of named factories forChannelobjects.- Returns:
- A list of
ChannelFactory-ies, nevernull
-
getAgentFactory
SshAgentFactory getAgentFactory()
Retrieve the agent factory for creatingSshAgentobjects.- Returns:
- The
SshAgentFactory
-
getScheduledExecutorService
ScheduledExecutorService getScheduledExecutorService()
Retrieve theScheduledExecutorServiceto be used.- Returns:
- The
ScheduledExecutorService, nevernull
-
getForwardingFilter
ForwardingFilter getForwardingFilter()
Retrieve theForwardingFilterto be used by the SSH server. If no filter has been configured (i.e. this method returnsnull), then all forwarding requests will be rejected.- Returns:
- The
ForwardingFilterornull
-
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
FileSystemFactory getFileSystemFactory()
Retrieve theFileSystemFactoryto be used to traverse the file system.- Returns:
- a valid
FileSystemFactoryinstance ornullif file based interactions are not supported on this server
-
getServiceFactories
List<? extends ServiceFactory> getServiceFactories()
Retrieve the list of SSHServicefactories.- Returns:
- a list of named
Servicefactories, nevernull
-
getGlobalRequestHandlers
List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()
Retrieve the list of global request handlers.- Returns:
- a list of named
GlobalRequestHandler
-
resolveAttribute
default <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key)
- Specified by:
resolveAttributein interfaceAttributeRepository
-
resolveAttribute
static <T> T resolveAttribute(FactoryManager manager, AttributeRepository.AttributeKey<T> key)
- Type Parameters:
T- The generic attribute type- Parameters:
manager- TheFactoryManager- ignored ifnullkey- The attribute key - nevernull- Returns:
- Associated value -
nullif not found
-
-