Enum BuiltinIdentities

java.lang.Object

java.lang.Enum<BuiltinIdentities>

org.apache.sshd.common.config.keys.BuiltinIdentities

All Implemented Interfaces:

Serializable, Comparable<BuiltinIdentities>, AlgorithmNameProvider, Identity, KeyTypeNamesSupport, NamedResource, OptionalFeature

public enum BuiltinIdentities
extends Enum<BuiltinIdentities>
implements Identity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BuiltinIdentities.Constants	Contains the names of the identities

Enum Constant Summary

Enum Constants

Enum Constant	Description
DSA
ECDSA
ED25119
RSA

Field Summary

Fields

Modifier and Type	Field	Description
private final String	algorithm
private final String	name
static final NavigableSet<String>	NAMES	A case insensitive NavigableSet of all built-in identities names
private final Class<? extends PrivateKey>	prvType
private final Class<? extends PublicKey>	pubType
private final NavigableSet<String>	types
static final Set<BuiltinIdentities>	VALUES

Fields inherited from interface NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface OptionalFeature

FALSE, TRUE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BuiltinIdentities(String type, Class<? extends PublicKey> pubType, Class<? extends PrivateKey> prvType, String keyType)
private	BuiltinIdentities(String name, String algorithm, Class<? extends PublicKey> pubType, Class<? extends PrivateKey> prvType, String keyType)
private	BuiltinIdentities(String name, String algorithm, Class<? extends PublicKey> pubType, Class<? extends PrivateKey> prvType, Collection<String> keyTypes)

Method Summary

Modifier and Type	Method	Description
static BuiltinIdentities	fromAlgorithm(String algorithm)
static BuiltinIdentities	fromKey(Key key)
static BuiltinIdentities	fromKeyPair(KeyPair kp)
static BuiltinIdentities	fromKeyType(Class<?> clazz)
static BuiltinIdentities	fromKeyTypeName(String typeName)
static BuiltinIdentities	fromName(String name)
String	getAlgorithm()
final String	getName()
final Class<? extends PrivateKey>	getPrivateKeyType()
final Class<? extends PublicKey>	getPublicKeyType()
NavigableSet<String>	getSupportedKeyTypes()
boolean	isSupported()
static BuiltinIdentities	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BuiltinIdentities[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RSA

public static final BuiltinIdentities RSA

DSA

public static final BuiltinIdentities DSA

ECDSA

public static final BuiltinIdentities ECDSA

ED25119

public static final BuiltinIdentities ED25119

Field Details

VALUES

public static final Set<BuiltinIdentities> VALUES

NAMES

public static final NavigableSet<String> NAMES

A case insensitive NavigableSet of all built-in identities names

name

private final String name

algorithm

private final String algorithm

pubType

private final Class<? extends PublicKey> pubType

prvType

private final Class<? extends PrivateKey> prvType

types

private final NavigableSet<String> types

Constructor Details

BuiltinIdentities

private BuiltinIdentities(String type,
 Class<? extends PublicKey> pubType,
 Class<? extends PrivateKey> prvType,
 String keyType)

BuiltinIdentities

private BuiltinIdentities(String name,
 String algorithm,
 Class<? extends PublicKey> pubType,
 Class<? extends PrivateKey> prvType,
 String keyType)

BuiltinIdentities

private BuiltinIdentities(String name,
 String algorithm,
 Class<? extends PublicKey> pubType,
 Class<? extends PrivateKey> prvType,
 Collection<String> keyTypes)

Method Details

values

public static BuiltinIdentities[] 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

public static BuiltinIdentities 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 name

NullPointerException - if the argument is null

getName

public final String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

isSupported

public boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

getSupportedKeyTypes

public NavigableSet<String> getSupportedKeyTypes()

Specified by:

getSupportedKeyTypes in interface KeyTypeNamesSupport

Returns:

The case insensitive NavigableSet of OpenSSH key type names that are supported by this decoder - e.g., ssh-rsa, ssh-dss, ecdsa-sha2-nistp384. This is not a single name - e.g., ECDSA keys have several curve names. Caveat: this collection may be un-modifiable...

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface AlgorithmNameProvider

getPublicKeyType

public final Class<? extends PublicKey> getPublicKeyType()

Specified by:

getPublicKeyType in interface Identity

getPrivateKeyType

public final Class<? extends PrivateKey> getPrivateKeyType()

Specified by:

getPrivateKeyType in interface Identity

fromName

public static BuiltinIdentities fromName(String name)

Parameters:

name - The identity name - ignored if null/empty

Returns:

The matching BuiltinIdentities whose getName() value matches case insensitive or null if no match found

fromAlgorithm

public static BuiltinIdentities fromAlgorithm(String algorithm)

Parameters:

algorithm - The algorithm - ignored if null/empty

Returns:

The matching BuiltinIdentities whose getAlgorithm() value matches case insensitive or null if no match found

fromKeyPair

public static BuiltinIdentities fromKeyPair(KeyPair kp)

Parameters:

kp - The KeyPair - ignored if null

Returns:

The matching BuiltinIdentities provided both public and public keys are of the same type - null if no match could be found

See Also:

• fromKey(Key)

fromKey

public static BuiltinIdentities fromKey(Key key)

Parameters:

key - The Key instance - ignored if null

Returns:

The matching BuiltinIdentities whose either public or private key type matches the requested one or null if no match found

See Also:

• fromKeyType(Class)

fromKeyType

public static BuiltinIdentities fromKeyType(Class<?> clazz)

Parameters:

clazz - The key type - ignored if null or not a Key class

Returns:

The matching BuiltinIdentities whose either public or private key type matches the requested one or null if no match found

See Also:

• getPublicKeyType()
• getPrivateKeyType()

fromKeyTypeName

public static BuiltinIdentities fromKeyTypeName(String typeName)

Parameters:

typeName - The OpenSSH key type e.g., ssh-rsa, ssh-dss, ecdsa-sha2-nistp384. Ignored if null/empty.

Returns:

The BuiltinIdentities that reported the type name as its getSupportedKeyTypes() (case insensitive) - null if no match found

See Also:

• KeyTypeNamesSupport.findSupporterByKeyTypeName(String, Collection)