Interface Config

All Known Implementing Classes:
AndroidConfig, ConfigImpl, DefaultConfig, DefaultSecurityProviderConfig
public interface Config
Holds configuration information and factories. Acts a container for factories of KeyExchange, Cipher, Compression, MAC, Signature, Random, and FileKeyProvider.

  • Method Details

    • getCipherFactories

      List<Factory.Named<Cipher>> getCipherFactories()
      Retrieve the list of named factories for Cipher.
      Returns:
      a list of named Cipher factories

    • getCompressionFactories

      List<Factory.Named<Compression>> getCompressionFactories()
      Retrieve the list of named factories for Compression.
      Returns:
      a list of named Compression factories

    • getFileKeyProviderFactories

      List<Factory.Named<FileKeyProvider>> getFileKeyProviderFactories()
      Retrieve the list of named factories for FileKeyProvider.
      Returns:
      a list of named FileKeyProvider factories

    • getKeyExchangeFactories

      List<Factory.Named<KeyExchange>> getKeyExchangeFactories()
      Retrieve the list of named factories for KeyExchange.
      Returns:
      a list of named KeyExchange factories

    • getMACFactories

      List<Factory.Named<MAC>> getMACFactories()
      Retrieve the list of named factories for MAC.
      Returns:
      a list of named MAC factories

    • getRandomFactory

      Factory<Random> getRandomFactory()
      Retrieve the Random factory.
      Returns:
      the Random factory

    • getKeyAlgorithms

      List<Factory.Named<KeyAlgorithm>> getKeyAlgorithms()
      Retrieve the list of named factories for KeyAlgorithm
      Returns:
      a list of named KeyAlgorithm factories

    • getVersion

      String getVersion()
      Returns the software version information for identification during SSH connection initialization. For example, "NET_3_0".

    • isVerifyHostKeyCertificates

      boolean isVerifyHostKeyCertificates()
      Returns true if host key certificates should be verified while connecting to the server. It is recommended to verify them, but can cause connection failures in cases when previous versions of the library could have managed to connect.

    • setCipherFactories

      void setCipherFactories(List<Factory.Named<Cipher>> cipherFactories)
      Set the named factories for Cipher.
      Parameters:
      cipherFactories - a list of named factories

    • setCompressionFactories

      void setCompressionFactories(List<Factory.Named<Compression>> compressionFactories)
      Set the named factories for Compression.
      Parameters:
      compressionFactories - a list of named factories

    • setFileKeyProviderFactories

      void setFileKeyProviderFactories(List<Factory.Named<FileKeyProvider>> fileKeyProviderFactories)
      Set the named factories for FileKeyProvider.
      Parameters:
      fileKeyProviderFactories - a list of named factories

    • setKeyExchangeFactories

      void setKeyExchangeFactories(List<Factory.Named<KeyExchange>> kexFactories)
      Set the named factories for KeyExchange.
      Parameters:
      kexFactories - a list of named factories

    • setMACFactories

      void setMACFactories(List<Factory.Named<MAC>> macFactories)
      Set the named factories for MAC.
      Parameters:
      macFactories - a list of named factories

    • setRandomFactory

      void setRandomFactory(Factory<Random> randomFactory)
      Set the factory for Random.
      Parameters:
      randomFactory - the factory

    • setKeyAlgorithms

      void setKeyAlgorithms(List<Factory.Named<KeyAlgorithm>> keyAlgorithms)
      Set the named factories for KeyAlgorithm.
      Parameters:
      keyAlgorithms - a list of named factories

    • setVersion

      void setVersion(String version)
      Set the software version information for identification during SSH connection initialization. For example, "SSHJ_0_1".
      Parameters:
      version - software version info

    • getKeepAliveProvider

      KeepAliveProvider getKeepAliveProvider()
      Returns:
      The provider that creates the keep-alive implementation of choice.

    • setKeepAliveProvider

      void setKeepAliveProvider(KeepAliveProvider keepAliveProvider)
      Set the provider that provides the keep-alive implementation.
      Parameters:
      keepAliveProvider - keep-alive provider

    • isWaitForServerIdentBeforeSendingClientIdent

      boolean isWaitForServerIdentBeforeSendingClientIdent()
      Gets whether the client should first wait for a received server ident, before sending the client ident.

      NB: This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident. The default value is set to false.

      Returns:
      Whether to first wait for the server ident.

    • setWaitForServerIdentBeforeSendingClientIdent

      void setWaitForServerIdentBeforeSendingClientIdent(boolean waitForServerIdentBeforeSendingClientIdent)
      Sets whether the SSH client should wait for a received server ident, before sending the client ident.

      NB: This is non-standard behaviour, and can potentially deadlock if the server also waits on the client ident.

      Parameters:
      waitForServerIdentBeforeSendingClientIdent - Whether to wait for the server ident.

    • setLoggerFactory

      void setLoggerFactory(LoggerFactory loggerFactory)
      Sets the LoggerFactory to use.

    • getLoggerFactory

      LoggerFactory getLoggerFactory()
      Returns:
      The LoggerFactory the SSHClient will use.

    • setVerifyHostKeyCertificates

      void setVerifyHostKeyCertificates(boolean value)
      Sets whether the SSH client should verify host key certificates or not. See isVerifyHostKeyCertificates().

    • getMaxCircularBufferSize

      int getMaxCircularBufferSize()

    • setMaxCircularBufferSize

      void setMaxCircularBufferSize(int maxCircularBufferSize)