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.

  • Field Details

  • 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

      Factory<? extends 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

      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(AttributeRepository.AttributeKey<T> key)
      Description copied from interface: AttributeRepository
      Attempts to resolve the associated value by going up the store's hierarchy (if any)
      Specified by:
      resolveAttribute in interface AttributeRepository
      Type Parameters:
      T - The generic attribute type
      Parameters:
      key - The key of the attribute; must not be null.
      Returns:
      null if there is no value associated with the specified key either in this repository or any of its ancestors (if any available)

    • resolveAttribute

      static <T> T resolveAttribute(FactoryManager manager, 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