Package org.apache.sshd.common.signature

Enum BuiltinSignatures

    • Field Detail

      • EXTENSIONS

        private static final java.util.Map<java.lang.String,​SignatureFactory> EXTENSIONS

      • factoryName

        private final java.lang.String factoryName

    • Constructor Detail

      • BuiltinSignatures

        private BuiltinSignatures​(java.lang.String facName)

    • 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​(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

      • getFactoryByCurveSize

        public static BuiltinSignatures getFactoryByCurveSize​(java.security.spec.ECParameterSpec params)

      • getSignerByCurveSize

        public static Signature getSignerByCurveSize​(java.security.spec.ECParameterSpec params)

      • getName

        public final java.lang.String getName()
        Specified by:
        getName in interface NamedResource
        Returns:
        The resource name

      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<BuiltinSignatures>

      • 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:
        java.lang.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 java.util.NavigableSet<SignatureFactory> getRegisteredExtensions()
        Returns:
        A NavigableSet of the currently registered extensions, sorted according to the factory name (case insensitive)

      • unregisterExtension

        public static SignatureFactory unregisterExtension​(java.lang.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​(java.lang.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

      • fromFactoryName

        public static BuiltinSignatures fromFactoryName​(java.lang.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​(java.lang.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

      • resolveFactory

        public static SignatureFactory resolveFactory​(java.lang.String name)
        Parameters:
        name - The factory name
        Returns:
        The factory or null if it is neither a built-in one or a registered extension