Package org.apache.sshd.common.kex
Enum BuiltinDHFactories
- All Implemented Interfaces:
Serializable
,Comparable<BuiltinDHFactories>
,java.lang.constant.Constable
,DHFactory
,NamedResource
,OptionalFeature
- Author:
- Apache MINA SSHD Project
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static final class
Represents the result ofparseDHFactoriesList(String)
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic BuiltinDHFactories
fromFactoryName
(String name) final String
getName()
static NavigableSet<DHFactory>
boolean
boolean
parseDHFactoriesList
(String dhList) parseDHFactoriesList
(String... dhList) parseDHFactoriesList
(Collection<String> dhList) static void
registerExtension
(DHFactory extension) Registered aNamedFactory
to be available besides the built-in ones when parsing configurationstatic DHFactory
resolveFactory
(String name) final String
toString()
static DHFactory
unregisterExtension
(String name) Unregisters specified extensionstatic BuiltinDHFactories
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.
-
Enum Constant Details
-
Field Details
-
VALUES
-
-
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:
getName
in interfaceNamedResource
-
isSupported
public boolean isSupported()- Specified by:
isSupported
in interfaceOptionalFeature
-
toString
- Overrides:
toString
in classEnum<BuiltinDHFactories>
-
registerExtension
Registered aNamedFactory
to 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
NavigableSet
of 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 -
null
if not found
-
fromFactoryName
- Parameters:
name
- The factory name - ignored ifnull
/empty- Returns:
- The matching
BuiltinDHFactories
(case insensitive) ornull
if no match found
-
isGroupExchange
public boolean isGroupExchange()- Specified by:
isGroupExchange
in interfaceDHFactory
-
parseDHFactoriesList
- Parameters:
dhList
- A comma-separated list of ciphers' names - ignored ifnull
/empty- Returns:
- A
BuiltinDHFactories.ParseResult
of 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
null
if it is neither a built-in one or a registered extension
-