Enum BuiltinDHFactories

java.lang.Object
java.lang.Enum<BuiltinDHFactories>
org.apache.sshd.common.kex.BuiltinDHFactories
All Implemented Interfaces:
Serializable, Comparable<BuiltinDHFactories>, DHFactory, NamedResource, OptionalFeature

public enum BuiltinDHFactories extends Enum<BuiltinDHFactories> implements DHFactory
  • Enum Constant Details

  • Field Details

  • Constructor Details

    • BuiltinDHFactories

      private BuiltinDHFactories(String name)
  • Method Details

    • values

      public static BuiltinDHFactories[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static BuiltinDHFactories valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getName

      public final String getName()
      Specified by:
      getName in interface NamedResource
      Returns:
      The resource name
    • isSupported

      public boolean isSupported()
      Specified by:
      isSupported in interface OptionalFeature
    • toString

      public final String toString()
      Overrides:
      toString in class Enum<BuiltinDHFactories>
    • registerExtension

      public static void registerExtension(DHFactory extension)
      Registered a NamedFactory to be available besides the built-in ones when parsing configuration
      Parameters:
      extension - The factory to register
      Throws:
      IllegalArgumentException - if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).
    • getRegisteredExtensions

      public static NavigableSet<DHFactory> getRegisteredExtensions()
      Returns:
      A NavigableSet of the currently registered extensions, sorted according to the factory name (case insensitive)
    • unregisterExtension

      public static DHFactory unregisterExtension(String name)
      Unregisters specified extension
      Parameters:
      name - The factory name - ignored if null/empty
      Returns:
      The registered extension - null if not found
    • fromFactoryName

      public static BuiltinDHFactories fromFactoryName(String name)
      Parameters:
      name - The factory name - ignored if null/empty
      Returns:
      The matching BuiltinDHFactories (case insensitive) or null if no match found
    • isGroupExchange

      public boolean isGroupExchange()
      Specified by:
      isGroupExchange in interface DHFactory
    • parseDHFactoriesList

      public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String dhList)
      Parameters:
      dhList - A comma-separated list of ciphers' names - ignored if null/empty
      Returns:
      A BuiltinDHFactories.ParseResult of all the DHFactory-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones. Note: it is up to caller to ensure that the list does not contain duplicates
    • parseDHFactoriesList

      public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String... dhList)
    • parseDHFactoriesList

      public static BuiltinDHFactories.ParseResult parseDHFactoriesList(Collection<String> dhList)
    • resolveFactory

      public static DHFactory resolveFactory(String name)
      Parameters:
      name - The factory name
      Returns:
      The factory or null if it is neither a built-in one or a registered extension