Package org.apache.sshd.common.kex
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
- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BuiltinDHFactories.Constants
static class
BuiltinDHFactories.ParseResult
Represents the result ofparseDHFactoriesList(String)
-
Field Summary
Fields Modifier and Type Field 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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BuiltinDHFactories
fromFactoryName(String name)
String
getName()
static NavigableSet<DHFactory>
getRegisteredExtensions()
boolean
isGroupExchange()
boolean
isSupported()
static BuiltinDHFactories.ParseResult
parseDHFactoriesList(String dhList)
static BuiltinDHFactories.ParseResult
parseDHFactoriesList(String... dhList)
static BuiltinDHFactories.ParseResult
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)
String
toString()
static DHFactory
unregisterExtension(String name)
Unregisters specified extensionstatic 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.
-
-
-
Enum Constant Detail
-
dhg1
public static final BuiltinDHFactories dhg1
-
dhg14
public static final BuiltinDHFactories dhg14
-
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
public static final BuiltinDHFactories dhgex
-
dhgex256
public static final BuiltinDHFactories dhgex256
-
ecdhp256
public static final BuiltinDHFactories ecdhp256
-
ecdhp384
public static final BuiltinDHFactories ecdhp384
-
ecdhp521
public static final BuiltinDHFactories ecdhp521
-
-
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 nameNullPointerException
- if the argument is null
-
getName
public final String getName()
- Specified by:
getName
in interfaceNamedResource
- Returns:
- The resource name
-
isSupported
public boolean isSupported()
- Specified by:
isSupported
in interfaceOptionalFeature
-
toString
public final String toString()
- Overrides:
toString
in classEnum<BuiltinDHFactories>
-
registerExtension
public static void registerExtension(DHFactory extension)
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
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 ifnull
/empty- Returns:
- The registered extension -
null
if not found
-
fromFactoryName
public static BuiltinDHFactories fromFactoryName(String name)
- 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
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String dhList)
- 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
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(String... dhList)
-
parseDHFactoriesList
public static BuiltinDHFactories.ParseResult parseDHFactoriesList(Collection<String> dhList)
-
-