1. Description
2. Method Summary
3. Method Details
   1. getAlgorithmProperty(String, String)
   2. insertProviderAt(Provider, int)
   3. addProvider(Provider)
   4. removeProvider(String)
   5. getProviders()
   6. getProvider(String)
   7. getProviders(String)
   8. getProviders(Map)
   9. getProperty(String)
   10. setProperty(String, String)
   11. getAlgorithms(String)

• Method Summary

  All MethodsStatic MethodsConcrete MethodsDeprecated Methods

  Modifier and Type

  Method

  Description

  static int

  addProvider(Provider provider)

  Adds a provider to the next position available.

  static String

  getAlgorithmProperty(String algName, String propName)

  Deprecated.

  This method used to return the value of a proprietary property in the master file of the "SUN" Cryptographic Service Provider in order to determine how to parse algorithm-specific parameters.

  static Set<String>

  getAlgorithms(String serviceName)

  Returns a Set of String objects containing the names of all available algorithms or types for the specified Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore).

  static String

  getProperty(String key)

  Gets a security property value.

  static Provider

  getProvider(String name)

  Returns the provider installed with the specified name, if any.

  static Provider[]

  getProviders()

  Returns an array containing all the installed providers.

  static Provider[]

  getProviders(String filter)

  Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed.

  static Provider[]

  getProviders(Map<String,String> filter)

  Returns an array containing all installed providers that satisfy the specified selection criteria, or null if no such providers have been installed.

  static int

  insertProviderAt(Provider provider, int position)

  Adds a new provider, at a specified position.

  static void

  removeProvider(String name)

  Removes the provider with the specified name.

  static void

  setProperty(String key, String datum)

  Sets a security property value.

  Methods declared in class Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Modifier and Type

  Method

  Description

  protected Object

  clone()

  Creates and returns a copy of this object.

  boolean

  equals(Object obj)

  Indicates whether some other object is "equal to" this one.

  protected void

  finalize()

  Deprecated, for removal: This API element is subject to removal in a future version.

  Finalization is deprecated and subject to removal in a future release.

  final Class<?>

  getClass()

  Returns the runtime class of this Object.

  int

  hashCode()

  Returns a hash code value for this object.

  final void

  notify()

  Wakes up a single thread that is waiting on this object's monitor.

  final void

  notifyAll()

  Wakes up all threads that are waiting on this object's monitor.

  String

  toString()

  Returns a string representation of the object.

  final void

  wait()

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

  final void

  wait(long timeoutMillis)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  final void

  wait(long timeoutMillis, int nanos)

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

• Method Details

  • getAlgorithmProperty

    @Deprecated public static String getAlgorithmProperty(String algName, String propName)

    Deprecated.

    This method used to return the value of a proprietary property in the master file of the "SUN" Cryptographic Service Provider in order to determine how to parse algorithm-specific parameters. Use the new provider-based and algorithm-independent AlgorithmParameters and KeyFactory engine classes (introduced in the J2SE version 1.2 platform) instead.

    Gets a specified property for an algorithm. The algorithm name should be a standard name. See the Java Security Standard Algorithm Names Specification for information about standard algorithm names. One possible use is by specialized algorithm parsers, which may map classes to algorithms which they understand (much like Key parsers do).

    Parameters: algName - the algorithm name. propName - the name of the property to get. Returns: the value of the specified property. External Specifications

    • Java Security Standard Algorithm Names

  • insertProviderAt

    public static int insertProviderAt(Provider provider, int position)

    Adds a new provider, at a specified position. The position is the preference order in which providers are searched for requested algorithms. The position is 1-based, that is, 1 is most preferred, followed by 2, and so on. If the position is less than 1 or greater than n, where n is the number of installed providers, the provider (if not already installed) is inserted at the end of the list, or at the n + 1 position.

    If the given provider is installed at the requested position, the provider that used to be at that position, and all providers with a position greater than position, are shifted up one position (towards the end of the list of installed providers).

    A provider cannot be added if it is already installed.

    Parameters: provider - the provider to be added. position - the preference position that the caller would like for this provider. Returns: the actual preference position in which the provider was added, or -1 if the provider was not added because it is already installed. Throws: NullPointerException - if provider is null See Also:

    • getProvider(String)
    • removeProvider(String)

  • addProvider

    public static int addProvider(Provider provider)

    Adds a provider to the next position available.

    Parameters: provider - the provider to be added. Returns: the preference position in which the provider was added, or -1 if the provider was not added because it is already installed. Throws: NullPointerException - if provider is null See Also:

    • getProvider(String)
    • removeProvider(String)

  • removeProvider

    public static void removeProvider(String name)

    Removes the provider with the specified name.

    When the specified provider is removed, all providers located at a position greater than where the specified provider was are shifted down one position (towards the head of the list of installed providers).

    This method returns silently if the provider is not installed or if name is null.

    Parameters: name - the name of the provider to remove. See Also:

    • getProvider(String)
    • addProvider(Provider)

  • getProviders

    public static Provider[] getProviders()

    Returns an array containing all the installed providers. The order of the providers in the array is their preference order.

    Returns: an array of all the installed providers.

  • getProvider

    public static Provider getProvider(String name)

    Returns the provider installed with the specified name, if any. Returns null if no provider with the specified name is installed or if name is null.

    Parameters: name - the name of the provider to get. Returns: the provider of the specified name. See Also:

    • removeProvider(String)
    • addProvider(Provider)

  • getProviders

    public static Provider[] getProviders(String filter)

    Returns an array containing all installed providers that satisfy the specified selection criterion, or null if no such providers have been installed. The returned providers are ordered according to their preference order.

    A cryptographic service is always associated with a particular algorithm or type. For example, a digital signature service is always associated with a particular algorithm (e.g., DSA), and a CertificateFactory service is always associated with a particular certificate type (e.g., X.509).

    The selection criterion must be specified in one of the following two formats:

    • <crypto_service>.<algorithm_or_type>

      The cryptographic service name must not contain any dots.

      A provider satisfies the specified selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service.

      For example, "CertificateFactory.X.509" would be satisfied by any provider that supplied a CertificateFactory implementation for X.509 certificates.

    • <crypto_service>.<algorithm_or_type> <attribute_name>:<attribute_value>

      The cryptographic service name must not contain any dots. There must be one or more space characters between the <algorithm_or_type> and the <attribute_name>.

      A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service and its implementation meets the constraint expressed by the specified attribute name/value pair.

      For example, "Signature.SHA1withDSA KeySize:1024" would be satisfied by any provider that implemented the SHA1withDSA signature algorithm with a keysize of 1024 (or larger).

    See the Java Security Standard Algorithm Names Specification for information about standard cryptographic service names, standard algorithm names and standard attribute names.

    Parameters: filter - the criterion for selecting providers. The filter is case-insensitive. Returns: all the installed providers that satisfy the selection criterion, or null if no such providers have been installed. Throws: InvalidParameterException - if the filter is not in the required format NullPointerException - if filter is null Since: 1.3 External Specifications

    • Java Security Standard Algorithm Names

    See Also:

    • getProviders(java.util.Map)

  • getProviders

    public static Provider[] getProviders(Map<String,String> filter)

    Returns an array containing all installed providers that satisfy the specified selection criteria, or null if no such providers have been installed. The returned providers are ordered according to their preference order.

    The selection criteria are represented by a map. Each map entry represents a selection criterion. A provider is selected iff it satisfies all selection criteria. The key for any entry in such a map must be in one of the following two formats:

    • <crypto_service>.<algorithm_or_type>

      The cryptographic service name must not contain any dots.

      The value associated with the key must be an empty string.

      A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service.

    • <crypto_service>. <algorithm_or_type> <attribute_name>

      The cryptographic service name must not contain any dots. There must be one or more space characters between the <algorithm_or_type> and the <attribute_name>.

      The value associated with the key must be a non-empty string. A provider satisfies this selection criterion iff the provider implements the specified algorithm or type for the specified cryptographic service and its implementation meets the constraint expressed by the specified attribute name/value pair.

    See the Java Security Standard Algorithm Names Specification for information about standard cryptographic service names, standard algorithm names and standard attribute names.

    Parameters: filter - the criteria for selecting providers. The filter is case-insensitive. Returns: all the installed providers that satisfy the selection criteria, or null if no such providers have been installed. Throws: InvalidParameterException - if the filter is not in the required format NullPointerException - if filter is null Since: 1.3 External Specifications

    • Java Security Standard Algorithm Names

    See Also:

    • getProviders(java.lang.String)

  • getProperty

    public static String getProperty(String key)

    Gets a security property value.

    Parameters: key - the key of the property being retrieved. Returns: the value of the security property, or null if there is no property with that key. Throws: NullPointerException - if key is null IllegalArgumentException - if key is reserved and cannot be used as a Security property name. Reserved keys are: "include". See Also:

    • setProperty(String, String)

  • setProperty

    public static void setProperty(String key, String datum)

    Sets a security property value.

    Parameters: key - the name of the property to be set. datum - the value of the property to be set. Throws: NullPointerException - if key or datum is null IllegalArgumentException - if key is reserved and cannot be used as a Security property name. Reserved keys are: "include". See Also:

    • getProperty(String)

  • getAlgorithms

    public static Set<String> getAlgorithms(String serviceName)

    Returns a Set of String objects containing the names of all available algorithms or types for the specified Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore). Returns an empty set if there is no provider that supports the specified service or if serviceName is null. For a complete list of Java cryptographic services, please see the Java Cryptography Architecture (JCA) Reference Guide. Note: the returned set is immutable.

    Parameters: serviceName - the name of the Java cryptographic service (e.g., Signature, MessageDigest, Cipher, Mac, KeyStore). Note: this parameter is case-insensitive. Returns: a Set of String objects containing the names of all available algorithms or types for the specified Java cryptographic service or an empty set if no provider supports the specified service. Since: 1.4

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.