BuiltinDHFactories (Apache Mina SSHD

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
```
Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BuiltinDHFactories.Constants`
`static class`	`BuiltinDHFactories.ParseResult` Represents the result of `parseDHFactoriesList(String)`

Enum Constant Summary

Enum Constants
Enum Constant and Description
`curve25519`
`curve25519_libssh`
`curve448`
`dhg1` Deprecated.
`dhg14` Deprecated.
`dhg14_256`
`dhg15_512`
`dhg16_512`
`dhg17_512`
`dhg18_512`
`dhgex` Deprecated.
`dhgex256`
`ecdhp256`
`ecdhp384`
`ecdhp521`
`sntrup761x25519`

Field Summary

Fields
Modifier and Type Field and Description

static Set<BuiltinDHFactories> VALUES
- Fields inherited from interface org.apache.sshd.common.NamedResource
  BY_NAME_COMPARATOR, NAME_EXTRACTOR
- Fields inherited from interface org.apache.sshd.common.OptionalFeature
  FALSE, TRUE

Fields
Modifier and Type	Field and Description
`static Set<BuiltinDHFactories>`	`VALUES`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BuiltinDHFactories`	`fromFactoryName(String name)`
`String`	`getName()`
`static NavigableSet<DHFactory>`	`getRegisteredExtensions()`
`boolean`	`isGroupExchange()`
`boolean`	`isSupported()`
`static BuiltinDHFactories.ParseResult`	`parseDHFactoriesList(Collection<String> dhList)`
`static BuiltinDHFactories.ParseResult`	`parseDHFactoriesList(String... dhList)`
`static BuiltinDHFactories.ParseResult`	`parseDHFactoriesList(String dhList)`
`static void`	`registerExtension(DHFactory extension)` Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration
`static DHFactory`	`resolveFactory(String name)`
`String`	`toString()`
`static DHFactory`	`unregisterExtension(String name)` Unregisters specified extension
`static BuiltinDHFactories`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BuiltinDHFactories[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.kex.DHFactory
create

Methods inherited from interface org.apache.sshd.common.NamedResource
findByName, findFirstMatchByName, getNameList, getNames, ofName, removeByName, safeCompareByName

Methods inherited from interface org.apache.sshd.common.OptionalFeature
all, any, of

- Enum Constant Detail
  - dhg1
```
@Deprecated
public static final BuiltinDHFactories dhg1
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - dhg14
```
@Deprecated
public static final BuiltinDHFactories dhg14
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - dhg14_256
```
public static final BuiltinDHFactories dhg14_256
```
  - dhg15_512
```
public static final BuiltinDHFactories dhg15_512
```
  - dhg16_512
```
public static final BuiltinDHFactories dhg16_512
```
  - dhg17_512
```
public static final BuiltinDHFactories dhg17_512
```
  - dhg18_512
```
public static final BuiltinDHFactories dhg18_512
```
  - dhgex
```
@Deprecated
public static final BuiltinDHFactories dhgex
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - dhgex256
```
public static final BuiltinDHFactories dhgex256
```
  - ecdhp256
```
public static final BuiltinDHFactories ecdhp256
```
  - ecdhp384
```
public static final BuiltinDHFactories ecdhp384
```
  - ecdhp521
```
public static final BuiltinDHFactories ecdhp521
```
  - curve25519
```
public static final BuiltinDHFactories curve25519
```
    See Also:
    
    RFC 8731
  - curve25519_libssh
```
public static final BuiltinDHFactories curve25519_libssh
```
  - curve448
```
public static final BuiltinDHFactories curve448
```
    See Also:
    
    RFC 8731
  - sntrup761x25519
```
public static final BuiltinDHFactories sntrup761x25519
```
    See Also:
    
    draft-josefsson-ntruprime-ssh-02.html
- Field Detail
  - VALUES
```
public static final Set<BuiltinDHFactories> VALUES
```
- Method Detail
  - values
```
public static BuiltinDHFactories[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (BuiltinDHFactories c : BuiltinDHFactories.values())
    System.out.println(c);
```
    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
  - 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

Enum BuiltinDHFactories

Nested Class Summary

Enum Constant Summary

Field Summary

Fields inherited from interface org.apache.sshd.common.NamedResource

Fields inherited from interface org.apache.sshd.common.OptionalFeature

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.sshd.common.kex.DHFactory

Methods inherited from interface org.apache.sshd.common.NamedResource

Methods inherited from interface org.apache.sshd.common.OptionalFeature

Enum Constant Detail

dhg1

dhg14

dhg14_256

dhg15_512

dhg16_512

dhg17_512

dhg18_512

dhgex

dhgex256

ecdhp256

ecdhp384

ecdhp521

curve25519

curve25519_libssh

curve448

sntrup761x25519

Field Detail

VALUES

Method Detail

values

valueOf

getName

isSupported

toString

registerExtension

getRegisteredExtensions

unregisterExtension

fromFactoryName

isGroupExchange

parseDHFactoriesList

parseDHFactoriesList

parseDHFactoriesList

resolveFactory