Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private final String	algorithm
public static final BuiltinIdentities	DSA
public static final BuiltinIdentities	ECDSA
public static final BuiltinIdentities	ED25119
private final String	name Hides java.lang.Enum.name.
public 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
public static final BuiltinIdentities	RSA
private final NavigableSet<String>	types
public static final Set<BuiltinIdentities>	VALUES

Access	Constructor and 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 and Description
public static BuiltinIdentities	Returns: The matching `BuiltinIdentities` whose `getAlgorithm()` value matches case insensitive or `null` if no match found fromAlgorithm(String The algorithm - ignored if `null`/empty algorithm)
public static BuiltinIdentities	Returns: The matching `BuiltinIdentities` whose either public or private key type matches the requested one or `null` if no match found fromKey(Key The `Key` instance - ignored if `null` key)
public static BuiltinIdentities	Returns: The matching `BuiltinIdentities` provided both public and public keys are of the same type - `null` if no match could be found fromKeyPair(KeyPair The `KeyPair` - ignored if `null` kp)
public static BuiltinIdentities	Returns: The matching `BuiltinIdentities` whose either public or private key type matches the requested one or `null` if no match found fromKeyType(Class<?> The key type - ignored if `null` or not a `Key` class clazz)
public static BuiltinIdentities	Returns: The `BuiltinIdentities` that reported the type name as its `getSupportedKeyTypes()` (case insensitive) - `null` if no match found fromKeyTypeName(String The `OpenSSH` key type e.g., `ssh-rsa, ssh-dss, ecdsa-sha2-nistp384`. Ignored if `null`/empty. typeName)
public static BuiltinIdentities	Returns: The matching `BuiltinIdentities` whose `getName()` value matches case insensitive or `null` if no match found fromName(String The identity name - ignored if `null`/empty name)
public String	getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public final Class<? extends PrivateKey>	getPrivateKeyType() Implements org.apache.sshd.common.config.keys.Identity.getPrivateKeyType.
public final Class<? extends PublicKey>	getPublicKeyType() Implements org.apache.sshd.common.config.keys.Identity.getPublicKeyType.
public NavigableSet<String>	getSupportedKeyTypes() Implements org.apache.sshd.common.config.keys.KeyTypeNamesSupport.getSupportedKeyTypes.
public boolean	isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public static BuiltinIdentities	valueOf(String name)
public static BuiltinIdentities[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

algorithm	back to summary
private final String algorithm

DSA	back to summary
public static final BuiltinIdentities DSA

ECDSA	back to summary
public static final BuiltinIdentities ECDSA

ED25119	back to summary
public static final BuiltinIdentities ED25119

name	back to summary
private final String name Hides java.lang.Enum.name.

NAMES	back to summary
public static final NavigableSet<String> NAMES A case insensitive `NavigableSet` of all built-in identities names

prvType	back to summary
private final Class<? extends PrivateKey> prvType

pubType	back to summary
private final Class<? extends PublicKey> pubType

RSA	back to summary
public static final BuiltinIdentities RSA

types	back to summary
private final NavigableSet<String> types

VALUES	back to summary
public static final Set<BuiltinIdentities> VALUES

Constructor Detail

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

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

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

Method Detail

fromAlgorithm	back to summary
public static BuiltinIdentities fromAlgorithm(String algorithm) Parameters algorithm:String The algorithm - ignored if `null`/empty Returns:BuiltinIdentities The matching `BuiltinIdentities` whose `getAlgorithm()` value matches case insensitive or `null` if no match found

fromKey	back to summary
public static BuiltinIdentities fromKey(Key key) Parameters key:Key The `Key` instance - ignored if `null` Returns:BuiltinIdentities The matching `BuiltinIdentities` whose either public or private key type matches the requested one or `null` if no match found See Also `fromKeyType(Class)`

fromKeyPair	back to summary
public static BuiltinIdentities fromKeyPair(KeyPair kp) Parameters kp:KeyPair The `KeyPair` - ignored if `null` Returns:BuiltinIdentities 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)`

fromKeyType	back to summary
public static BuiltinIdentities fromKeyType(Class<?> clazz) Parameters clazz:Class<?> The key type - ignored if `null` or not a `Key` class Returns:BuiltinIdentities 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 back to summary

fromKeyTypeName	back to summary
public static BuiltinIdentities fromKeyTypeName(String typeName) Parameters typeName:String The `OpenSSH` key type e.g., `ssh-rsa, ssh-dss, ecdsa-sha2-nistp384`. Ignored if `null`/empty. Returns:BuiltinIdentities The `BuiltinIdentities` that reported the type name as its `getSupportedKeyTypes()` (case insensitive) - `null` if no match found See Also `KeyTypeNamesSupport#findSupporterByKeyTypeName(String, Collection)`

public static BuiltinIdentities fromKeyTypeName(String typeName)

Parameters

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

Returns:BuiltinIdentities

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

fromName	back to summary
public static BuiltinIdentities fromName(String name) Parameters name:String The identity name - ignored if `null`/empty Returns:BuiltinIdentities The matching `BuiltinIdentities` whose `getName()` value matches case insensitive or `null` if no match found

getAlgorithm	back to summary
public String getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm. Annotations @Override

getAlgorithm

back to summary

public String getAlgorithm()

Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.

Annotations

@Override

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

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

Returns:String

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

The resource name

Annotations

@Override

getPrivateKeyType	back to summary
public final Class<? extends PrivateKey> getPrivateKeyType() Implements org.apache.sshd.common.config.keys.Identity.getPrivateKeyType. Annotations @Override

getPrivateKeyType

back to summary

public final Class<? extends PrivateKey> getPrivateKeyType()

Implements org.apache.sshd.common.config.keys.Identity.getPrivateKeyType.

Annotations

@Override

getPublicKeyType	back to summary
public final Class<? extends PublicKey> getPublicKeyType() Implements org.apache.sshd.common.config.keys.Identity.getPublicKeyType. Annotations @Override

getPublicKeyType

back to summary

public final Class<? extends PublicKey> getPublicKeyType()

Implements org.apache.sshd.common.config.keys.Identity.getPublicKeyType.

Annotations

@Override

getSupportedKeyTypes back to summary

getSupportedKeyTypes	back to summary
public NavigableSet<String> getSupportedKeyTypes() Implements org.apache.sshd.common.config.keys.KeyTypeNamesSupport.getSupportedKeyTypes. Returns:NavigableSet<String> Doc from org.apache.sshd.common.config.keys.KeyTypeNamesSupport.getSupportedKeyTypes. 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... Annotations @Override

public NavigableSet<String> getSupportedKeyTypes()

Implements org.apache.sshd.common.config.keys.KeyTypeNamesSupport.getSupportedKeyTypes.

Returns:NavigableSet<String>

Doc from org.apache.sshd.common.config.keys.KeyTypeNamesSupport.getSupportedKeyTypes.

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...

Annotations

@Override

isSupported	back to summary
public boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Annotations @Override

isSupported

back to summary

public boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Annotations

@Override

valueOf	back to summary
public static BuiltinIdentities valueOf(String name)

values	back to summary
public static BuiltinIdentities[] values()

org.apache.sshd.common.config.keys back to summary

public final Class BuiltinIdentities.Constants

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.common.config.keys.BuiltinIdentities.Constants

Contains the names of the identities

Field Summary

Modifier and Type	Field and Description
public static final String	DSA
public static final String	ECDSA
public static final String	ED25519
public static final String	RSA

Constructor Summary

Access	Constructor and Description
private	Constants()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DSA	back to summary
public static final String DSA

ECDSA	back to summary
public static final String ECDSA

ED25519	back to summary
public static final String ED25519

RSA	back to summary
public static final String RSA

Constructor Detail

Constants	back to summary
private Constants()

public sealed Enum BuiltinIdentities

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BuiltinIdentities.Constants

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail