Package org.apache.sshd.common

Interface FactoryManager

    • Field Detail

      • DEFAULT_VERSION

        static final java.lang.String DEFAULT_VERSION
        The default REPORTED_VERSION of getVersion() if the built-in version information cannot be accessed
        See Also:
        Constant Field Values

    • Method Detail

      • getVersion

        java.lang.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

      • getRandomFactory

        Factory<? extends Random> getRandomFactory()
        Retrieve the Random factory to be used.
        Returns:
        The Random factory, never null

      • getChannelFactories

        java.util.List<? extends ChannelFactory> getChannelFactories()
        Retrieve the list of named factories for Channel objects.
        Returns:
        A list of ChannelFactory-ies, never null

      • getScheduledExecutorService

        java.util.concurrent.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

      • 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

        java.util.List<? extends ServiceFactory> getServiceFactories()
        Retrieve the list of SSH Service factories.
        Returns:
        a list of named Service factories, never null

      • getGlobalRequestHandlers

        java.util.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