Package org.apache.sshd.server.auth
Enum BuiltinUserAuthFactories
- java.lang.Object
-
- java.lang.Enum<BuiltinUserAuthFactories>
-
- org.apache.sshd.server.auth.BuiltinUserAuthFactories
-
- All Implemented Interfaces:
Serializable
,Comparable<BuiltinUserAuthFactories>
,Supplier<UserAuthFactory>
,Factory<UserAuthFactory>
,NamedFactory<UserAuthFactory>
,NamedResource
public enum BuiltinUserAuthFactories extends Enum<BuiltinUserAuthFactories> implements NamedFactory<UserAuthFactory>
Provides a centralized location for the default built-in authentication factories- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BuiltinUserAuthFactories.ParseResult
Holds the result ofparseFactoriesList(String)
-
Enum Constant Summary
Enum Constants Enum Constant Description GSS
HOSTBASED
KBINTERACTIVE
PASSWORD
PUBLICKEY
-
Field Summary
Fields Modifier and Type Field Description static Set<BuiltinUserAuthFactories>
VALUES
-
Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UserAuthFactory
create()
static UserAuthFactory
fromFactoryName(String name)
String
getName()
static BuiltinUserAuthFactories.ParseResult
parseFactoriesList(String factories)
static BuiltinUserAuthFactories.ParseResult
parseFactoriesList(String... factories)
static BuiltinUserAuthFactories.ParseResult
parseFactoriesList(Collection<String> factories)
static UserAuthFactory
resolveFactory(String name)
static BuiltinUserAuthFactories
valueOf(String name)
Returns the enum constant of this type with the specified name.static BuiltinUserAuthFactories[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PASSWORD
public static final BuiltinUserAuthFactories PASSWORD
-
PUBLICKEY
public static final BuiltinUserAuthFactories PUBLICKEY
-
KBINTERACTIVE
public static final BuiltinUserAuthFactories KBINTERACTIVE
-
HOSTBASED
public static final BuiltinUserAuthFactories HOSTBASED
-
GSS
public static final BuiltinUserAuthFactories GSS
-
-
Field Detail
-
VALUES
public static final Set<BuiltinUserAuthFactories> VALUES
-
-
Method Detail
-
values
public static BuiltinUserAuthFactories[] 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 (BuiltinUserAuthFactories c : BuiltinUserAuthFactories.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static BuiltinUserAuthFactories 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
-
create
public UserAuthFactory create()
- Specified by:
create
in interfaceFactory<UserAuthFactory>
-
getName
public String getName()
- Specified by:
getName
in interfaceNamedResource
-
fromFactoryName
public static UserAuthFactory fromFactoryName(String name)
- Parameters:
name
- The factory name (case insensitive) - ignored ifnull
/empty- Returns:
- The matching factory instance -
null
if no match found
-
parseFactoriesList
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(String factories)
- Parameters:
factories
- A comma-separated list of factories' names - ignored ifnull
/empty- Returns:
- A
BuiltinUserAuthFactories.ParseResult
containing the successfully parsed factories and the unknown ones. Note: it is up to caller to ensure that the lists do not contain duplicates
-
parseFactoriesList
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(String... factories)
-
parseFactoriesList
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(Collection<String> factories)
-
resolveFactory
public static UserAuthFactory resolveFactory(String name)
-
-