Package org.apache.sshd.common.kex
Enum BuiltinDHFactories
- All Implemented Interfaces:
Serializable,Comparable<BuiltinDHFactories>,DHFactory,NamedResource,OptionalFeature
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classstatic final classRepresents the result ofparseDHFactoriesList(String) -
Enum Constant Summary
Enum Constants -
Field Summary
FieldsFields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTORFields inherited from interface org.apache.sshd.common.OptionalFeature
FALSE, TRUE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic BuiltinDHFactoriesfromFactoryName(String name) final StringgetName()static NavigableSet<DHFactory> booleanbooleanparseDHFactoriesList(String dhList) parseDHFactoriesList(String... dhList) parseDHFactoriesList(Collection<String> dhList) static voidregisterExtension(DHFactory extension) Registered aNamedFactoryto be available besides the built-in ones when parsing configurationstatic DHFactoryresolveFactory(String name) final StringtoString()static DHFactoryunregisterExtension(String name) Unregisters specified extensionstatic BuiltinDHFactoriesReturns 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.
-
Enum Constant Details
-
dhg1
Deprecated.- See Also:
-
dhg14
Deprecated.- See Also:
-
dhg14_256
-
dhg15_512
-
dhg16_512
-
dhg17_512
-
dhg18_512
-
dhgex
Deprecated.- See Also:
-
dhgex256
-
ecdhp256
-
ecdhp384
-
ecdhp521
-
curve25519
- See Also:
-
curve25519_libssh
-
curve448
- See Also:
-
-
Field Details
-
VALUES
-
EXTENSIONS
-
factoryName
-
-
Constructor Details
-
BuiltinDHFactories
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getName
- Specified by:
getNamein interfaceNamedResource- Returns:
- The resource name
-
isSupported
public boolean isSupported()- Specified by:
isSupportedin interfaceOptionalFeature
-
toString
- Overrides:
toStringin classEnum<BuiltinDHFactories>
-
registerExtension
Registered aNamedFactoryto be available besides the built-in ones when parsing configuration- Parameters:
extension- The factory to register- Throws:
IllegalArgumentException- if factory instance isnull, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).
-
getRegisteredExtensions
- Returns:
- A
NavigableSetof the currently registered extensions, sorted according to the factory name (case insensitive)
-
unregisterExtension
Unregisters specified extension- Parameters:
name- The factory name - ignored ifnull/empty- Returns:
- The registered extension -
nullif not found
-
fromFactoryName
- Parameters:
name- The factory name - ignored ifnull/empty- Returns:
- The matching
BuiltinDHFactories(case insensitive) ornullif no match found
-
isGroupExchange
public boolean isGroupExchange()- Specified by:
isGroupExchangein interfaceDHFactory
-
parseDHFactoriesList
- Parameters:
dhList- A comma-separated list of ciphers' names - ignored ifnull/empty- Returns:
- A
BuiltinDHFactories.ParseResultof all theDHFactory-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
-
parseDHFactoriesList
-
resolveFactory
- Parameters:
name- The factory name- Returns:
- The factory or
nullif it is neither a built-in one or a registered extension
-