Top Description Inners Fields Constructors Methods
org.apache.sshd.client.auth

public final Enum BuiltinUserAuthFactories

extends Enum<BuiltinUserAuthFactories>
implements NamedFactory<UserAuthFactory>
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.NamedFactory, org.apache.sshd.common.NamedResource, org.apache.sshd.common.Factory, java.util.function.Supplier
Imports
java.util.ArrayList, .Arrays, .Collection, .Collections, .EnumSet, .List, .Objects, .Set, org.apache.sshd.client.auth.hostbased.UserAuthHostBasedFactory, org.apache.sshd.client.auth.keyboard.UserAuthKeyboardInteractiveFactory, org.apache.sshd.client.auth.password.UserAuthPasswordFactory, org.apache.sshd.client.auth.pubkey.UserAuthPublicKeyFactory, org.apache.sshd.common.Factory, .NamedFactory, .NamedResource, org.apache.sshd.common.config.NamedFactoriesListParseResult, org.apache.sshd.common.util.GenericUtils
Provides a centralized location for the default built-in authentication factories
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
BuiltinUserAuthFactories.ParseResult

Holds the result of BuiltinUserAuthFactories#parseFactoriesList(String)

Field Summary

Modifier and TypeField and Description
private final UserAuthFactory
factory

public static final BuiltinUserAuthFactories
HOSTBASED

public static final BuiltinUserAuthFactories
KBINTERACTIVE

public static final BuiltinUserAuthFactories
PASSWORD

public static final BuiltinUserAuthFactories
PUBLICKEY

public static final Set<BuiltinUserAuthFactories>
VALUES

Constructor Summary

AccessConstructor and Description
private
BuiltinUserAuthFactories(UserAuthFactory factory)

Method Summary

Modifier and TypeMethod and Description
public UserAuthFactory
create()

Implements org.apache.sshd.common.Factory.create.

public static UserAuthFactory

Returns:

The matching factory instance - null if no match found
fromFactoryName(String
The factory name (case insensitive) - ignored if null/empty
name)

public String
getName()

Implements org.apache.sshd.common.NamedResource.getName.

public static BuiltinUserAuthFactories.ParseResult

Returns:

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

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

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

public static UserAuthFactory
resolveFactory(String name)

public static BuiltinUserAuthFactories
valueOf(String name)

public static BuiltinUserAuthFactories[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

factoryback to summary
private final UserAuthFactory factory
HOSTBASEDback to summary
public static final BuiltinUserAuthFactories HOSTBASED
KBINTERACTIVEback to summary
public static final BuiltinUserAuthFactories KBINTERACTIVE
PASSWORDback to summary
public static final BuiltinUserAuthFactories PASSWORD
PUBLICKEYback to summary
public static final BuiltinUserAuthFactories PUBLICKEY
VALUESback to summary
public static final Set<BuiltinUserAuthFactories> VALUES

Constructor Detail

BuiltinUserAuthFactoriesback to summary
private BuiltinUserAuthFactories(UserAuthFactory factory)

Method Detail

createback to summary
public UserAuthFactory create()

Implements org.apache.sshd.common.Factory.create.

Returns:UserAuthFactory

Doc from org.apache.sshd.common.Factory.create.

A new instance

Annotations
@Override
fromFactoryNameback to summary
public static UserAuthFactory fromFactoryName(String name)
Parameters
name:String

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

Returns:UserAuthFactory

The matching factory instance - null if no match found

getNameback to summary
public String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations
@Override
parseFactoriesListback to summary
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(String factories)
Parameters
factories:String

A comma-separated list of factories' names - ignored if null/empty

Returns:BuiltinUserAuthFactories.ParseResult

A 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

parseFactoriesListback to summary
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(String... factories)
parseFactoriesListback to summary
public static BuiltinUserAuthFactories.ParseResult parseFactoriesList(Collection<String> factories)
resolveFactoryback to summary
public static UserAuthFactory resolveFactory(String name)
valueOfback to summary
public static BuiltinUserAuthFactories valueOf(String name)
valuesback to summary
public static BuiltinUserAuthFactories[] values()
org.apache.sshd.client.auth back to summary

public Class BuiltinUserAuthFactories.ParseResult

extends NamedFactoriesListParseResult<UserAuth, UserAuthFactory>
Class Inheritance
Holds the result of BuiltinUserAuthFactories#parseFactoriesList(String)
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final BuiltinUserAuthFactories.ParseResult
EMPTY

Constructor Summary

AccessConstructor and Description
public
ParseResult(List<UserAuthFactory> parsed, List<String> unsupported)

Method Summary

Inherited from org.apache.sshd.common.config.NamedFactoriesListParseResult:
toString

Field Detail

EMPTYback to summary
public static final BuiltinUserAuthFactories.ParseResult EMPTY

Constructor Detail

ParseResultback to summary
public ParseResult(List<UserAuthFactory> parsed, List<String> unsupported)