org.apache.sshd.common.signature

Enum BuiltinSignatures

java.lang.Object

java.lang.Enum<BuiltinSignatures>

org.apache.sshd.common.signature.BuiltinSignatures

All Implemented Interfaces:

Serializable, Comparable<BuiltinSignatures>, BuiltinFactory<Signature>, Factory<Signature>, NamedFactory<Signature>, NamedResource, OptionalFeature, SignatureFactory

public enum BuiltinSignatures
extends Enum<BuiltinSignatures>
implements SignatureFactory

Provides easy access to the currently implemented signatures

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.apache.sshd.common.BuiltinFactory

BuiltinFactory.Utils

Enum Constant Summary

Enum Constants

Enum Constant and Description
dsa
nistp256
nistp384
nistp521
rsa

Field Summary

Fields

Modifier and Type	Field and Description
static Set<BuiltinSignatures>	VALUES

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
static BuiltinSignatures	fromFactory(NamedFactory<Digest> factory)
static BuiltinSignatures	fromFactoryName(String name)
static BuiltinSignatures	fromString(String s)
static Signature	getByCurveSize(ECParameterSpec params)
String	getName()
static SortedSet<SignatureFactory>	getRegisteredExtensions()
boolean	isSupported()
static BuiltinSignatures.ParseResult	parseSignatureList(Collection<String> sigs)
static BuiltinSignatures.ParseResult	parseSignatureList(String... sigs)
static BuiltinSignatures.ParseResult	parseSignatureList(String sigs)
static void	registerExtension(SignatureFactory extension) Registered a NamedFactory to be available besides the built-in ones when parsing configuration
static SignatureFactory	resolveFactory(String name)
String	toString()
static SignatureFactory	unregisterExtension(String name) Unregisters specified extension
static BuiltinSignatures	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuiltinSignatures[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

create

Enum Constant Detail

dsa

public static final BuiltinSignatures dsa

rsa

public static final BuiltinSignatures rsa

nistp256

public static final BuiltinSignatures nistp256

nistp384

public static final BuiltinSignatures nistp384

nistp521

public static final BuiltinSignatures nistp521

Field Detail

VALUES

public static final Set<BuiltinSignatures> VALUES

Method Detail

values

public static BuiltinSignatures[] 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 (BuiltinSignatures c : BuiltinSignatures.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuiltinSignatures 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

getByCurveSize

public static Signature getByCurveSize(ECParameterSpec params)

getName

public final String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

toString

public final String toString()

Overrides:

toString in class Enum<BuiltinSignatures>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

registerExtension

public static void registerExtension(SignatureFactory extension)

Registered a NamedFactory to be available besides the built-in ones when parsing configuration

Parameters:

extension - The factory to register

Throws:

IllegalArgumentException - if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).

getRegisteredExtensions

public static SortedSet<SignatureFactory> getRegisteredExtensions()

Returns:

A SortedSet of the currently registered extensions, sorted according to the factory name (case insensitive)

unregisterExtension

public static SignatureFactory unregisterExtension(String name)

Unregisters specified extension

Parameters:

name - The factory name - ignored if null/empty

Returns:

The registered extension - null if not found

fromString

public static BuiltinSignatures fromString(String s)

Parameters:

s - The Enum's name - ignored if null/empty

Returns:

The matching BuiltinSignatures whose Enum.name() matches (case insensitive) the provided argument - null if no match

fromFactory

public static BuiltinSignatures fromFactory(NamedFactory<Digest> factory)

Parameters:

factory - The NamedFactory for the cipher - ignored if null

Returns:

The matching BuiltinSignatures whose factory name matches (case insensitive) the digest factory name

See Also:

fromFactoryName(String)

fromFactoryName

public static BuiltinSignatures fromFactoryName(String name)

Parameters:

name - The factory name - ignored if null/empty

Returns:

The matching BuiltinSignatures whose factory name matches (case insensitive) the provided name - null if no match

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(String sigs)

Parameters:

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

Returns:

A BuiltinSignatures.ParseResult of all the NamedFactory whose name appears in the string and represent a built-in signature. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown signatures. Note: it is up to caller to ensure that the list does not contain duplicates

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(String... sigs)

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(Collection<String> sigs)

resolveFactory

public static SignatureFactory resolveFactory(String name)

Parameters:

name - The factory name

Returns:

The factory or null if it is neither a built-in one or a registered extension