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 the
NamedFactory used in the SSH protocol.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository
AttributeRepository.AttributeKey<T>Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
SessionHeartbeatController.HeartbeatType -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe defaultREPORTED_VERSIONofgetVersion()if the built-in version information cannot be accessedFields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver
NONEFields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY -
Method Summary
Modifier and TypeMethodDescriptionRetrieve the agent factory for creatingSshAgentobjects.default AgentForwardingFilterList<? extends ChannelFactory> Retrieve the list of named factories forChannelobjects.Retrieve theFileSystemFactoryto be used to traverse the file system.Retrieve the forwarder factory used to support forwarding.Retrieve theForwardingFilterto be used by the SSH server.Retrieve the list of global request handlers.Retrieve theRandomfactory to be used.Retrieve theScheduledExecutorServiceto be used.List<? extends ServiceFactory> Retrieve the list of SSHServicefactories.default TcpForwardingFilterAn upper case string identifying the version of the software used on client or server side.default X11ForwardingFilterdefault <T> TAttempts to resolve the associated value by going up the store's hierarchy (if any)static <T> TresolveAttribute(FactoryManager manager, AttributeRepository.AttributeKey<T> key) Methods inherited from interface org.apache.sshd.common.AttributeRepository
attributeKeys, getAttribute, getAttributesCountMethods inherited from interface org.apache.sshd.common.AttributeStore
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttributeMethods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListenerMethods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager
getChannelStreamWriterResolver, resolveChannelStreamWriter, resolveChannelStreamWriterResolver, setChannelStreamWriterResolverMethods inherited from interface org.apache.sshd.common.io.IoServiceEventListenerManager
getIoServiceEventListener, setIoServiceEventListenerMethods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager
getKexExtensionHandler, setKexExtensionHandlerMethods 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, setMacFactoriesNamesMethods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListenerMethods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty, isEmptyMethods inherited from interface org.apache.sshd.common.session.ReservedSessionMessagesManager
getReservedSessionMessagesHandler, setReservedSessionMessagesHandlerMethods inherited from interface org.apache.sshd.common.session.SessionDisconnectHandlerManager
getSessionDisconnectHandler, setSessionDisconnectHandlerMethods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeatMethods inherited from interface org.apache.sshd.common.session.SessionListenerManager
addSessionListener, getSessionListenerProxy, removeSessionListenerMethods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesHolder
getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNamesMethods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager
setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNamesMethods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
-
Field Details
-
DEFAULT_VERSION
The defaultREPORTED_VERSIONofgetVersion()if the built-in version information cannot be accessed- See Also:
-
-
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
IoServiceFactory getIoServiceFactory() -
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
-
getAgentForwardingFilter
-
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
Description copied from interface:AttributeRepositoryAttempts to resolve the associated value by going up the store's hierarchy (if any)- Specified by:
resolveAttributein interfaceAttributeRepository- Type Parameters:
T- The generic attribute type- Parameters:
key- The key of the attribute; must not benull.- Returns:
nullif there is no value associated with the specified key either in this repository or any of its ancestors (if any available)
-
resolveAttribute
- Type Parameters:
T- The generic attribute type- Parameters:
manager- TheFactoryManager- ignored ifnullkey- The attribute key - nevernull- Returns:
- Associated value -
nullif not found
-