org.apache.sshd.client.auth

Enum BuiltinUserAuthFactories

java.lang.Object

java.lang.Enum<BuiltinUserAuthFactories>

org.apache.sshd.client.auth.BuiltinUserAuthFactories

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuiltinUserAuthFactories>, java.util.function.Supplier<UserAuthFactory>, Factory<UserAuthFactory>, NamedFactory<UserAuthFactory>, NamedResource

public enum BuiltinUserAuthFactories
extends java.lang.Enum<BuiltinUserAuthFactories>
implements NamedFactory<UserAuthFactory>

Provides a centralized location for the default built-in authentication factories

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuiltinUserAuthFactories.ParseResult Holds the result of parseFactoriesList(String)

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOSTBASED
KBINTERACTIVE
PASSWORD
PUBLICKEY

Field Summary

Fields

Modifier and Type	Field and Description
private UserAuthFactory	factory
static java.util.Set<BuiltinUserAuthFactories>	VALUES

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
UserAuthFactory	create()
static UserAuthFactory	fromFactoryName(java.lang.String name)
java.lang.String	getName()
static BuiltinUserAuthFactories.ParseResult	parseFactoriesList(java.util.Collection<java.lang.String> factories)
static BuiltinUserAuthFactories.ParseResult	parseFactoriesList(java.lang.String... factories)
static BuiltinUserAuthFactories.ParseResult	parseFactoriesList(java.lang.String factories)
static UserAuthFactory	resolveFactory(java.lang.String name)
static BuiltinUserAuthFactories	valueOf(java.lang.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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

create, setUpBuiltinFactories, setUpTransformedFactories

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

get

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

findByName, getNameList, getNames, ofName, removeByName

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

Field Detail

VALUES

public static final java.util.Set<BuiltinUserAuthFactories> VALUES

factory

private final UserAuthFactory factory

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

create

public UserAuthFactory create()

Specified by:

create in interface Factory<UserAuthFactory>

Returns:

A new instance

getName

public java.lang.String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

fromFactoryName

public static UserAuthFactory fromFactoryName(java.lang.String name)

Parameters:

name - The factory name (case insensitive) - ignored if null/empty

Returns:

The matching factory instance - null if no match found

parseFactoriesList

public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(java.lang.String factories)

Parameters:

factories - A comma-separated list of factories' names - ignored if null/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(java.lang.String... factories)

parseFactoriesList

public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(java.util.Collection<java.lang.String> factories)

resolveFactory

public static UserAuthFactory resolveFactory(java.lang.String name)