Added in API level 1

Provider

abstract class Provider : Properties

kotlin.Any
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<kotlin.Any, kotlin.Any>
		↳	java.util.Properties
			↳	java.security.Provider

Known Direct Subclasses AuthProvider AuthProvider Legacy security code; do not use.

This class represents a "provider" for the Java Security API, where a provider implements some or all parts of Java Security. Services that a provider may implement include:

• Algorithms (such as DSA, RSA, MD5 or SHA-1).
• Key generation, conversion, and management facilities (such as for algorithm-specific keys).

Each provider has a name and a version number, and is configured in each runtime it is installed in.

See The Provider Class in the "Java Cryptography Architecture API Specification & Reference" for information about how a particular type of provider, the cryptographic service provider, works and is installed. However, please note that a provider can be used to implement any security service in Java that uses a pluggable architecture with a choice of implementations that fit underneath.

Some provider implementations may encounter unrecoverable internal errors during their operation, for example a failure to communicate with a security token. A ProviderException should be used to indicate such errors.

The service type Provider is reserved for use by the security framework. Services of this type cannot be added, removed, or modified by applications. The following attributes are automatically placed in each Provider object:

Attributes Automatically Placed in a Provider Object

Name	Value
Provider.id name	String.valueOf(provider.getName())
Provider.id version	String.valueOf(provider.getVersion())
Provider.id info	String.valueOf(provider.getInfo())
Provider.id className	provider.getClass().getName()

Summary

Nested classes
open	Service The description of a security service.

Protected constructors
Provider(name: String!, version: Double, info: String!) Constructs a provider with the specified name, version number, and information.

Public methods
open Unit	clear() Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider.
open Any?	compute(key: Any!, remappingFunction: BiFunction<in Any!, in Any?, *>) Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
open Any!	computeIfAbsent(key: Any!, mappingFunction: Function<in Any!, *>) If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
open Any?	computeIfPresent(key: Any!, remappingFunction: BiFunction<in Any!, in Any, *>) If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.
open Enumeration<Any!>!	elements()
open Unit	forEach(action: BiConsumer<in Any!, in Any!>)
open Any?	get(key: Any!)
open String!	getInfo() Returns a human-readable description of the provider and its services.
open String!	getName() Returns the name of this provider.
open Any!	getOrDefault(key: Any!, defaultValue: Any!)
open String!	getProperty(key: String!)
open Provider.Service!	getService(type: String!, algorithm: String!) Get the service describing this Provider's implementation of the specified type of this algorithm or alias.
open MutableSet<Provider.Service!>!	getServices() Get an unmodifiable Set of all services supported by this Provider.
open Double	getVersion() Returns the version number for this provider.
open Enumeration<Any!>!	keys()
open Unit	load(inStream: InputStream!) Reads a property list (key and element pairs) from the input stream.
open Any?	merge(key: Any!, value: Any, remappingFunction: BiFunction<in Any, in Any, *>) If the specified key is not already associated with a value or is associated with null, associates it with the given value.
open Any?	put(key: Any!, value: Any!) Sets the key property to have the specified value.
open Unit	putAll(from: Map<*, *>) Copies all of the mappings from the specified Map to this provider.
open Any?	putIfAbsent(key: Any!, value: Any!) If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.
open Any?	remove(key: Any!) Removes the key property (and its corresponding value).
open Boolean	remove(key: Any!, value: Any!) Removes the entry for the specified key only if it is currently mapped to the specified value.
open Any?	replace(key: Any!, value: Any!) Replaces the entry for the specified key only if it is currently mapped to some value.
open Boolean	replace(key: Any!, oldValue: Any!, newValue: Any!) Replaces the entry for the specified key only if currently mapped to the specified value.
open Unit	replaceAll(function: BiFunction<in Any!, in Any!, *>) Replaces each entry's value with the result of invoking the given function on that entry, in the order entries are returned by an entry set iterator, until all entries have been processed or the function throws an exception.
open String	toString() Returns a string with the name and the version number of this provider.

Protected methods
open Unit	putService(s: Provider.Service!) Add a service.
open Unit	removeService(s: Provider.Service!) Remove a service previously added using putService().

Inherited functions

From class Properties Any clone() Boolean contains(value: Any!) Boolean containsKey(key: Any!) Boolean containsValue(value: Any!) Boolean equals(other: Any?) String! getProperty(key: String!, defaultValue: String!) Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found. Int hashCode() Boolean isEmpty() Unit list(out: PrintStream!) Prints this property list out to the specified output stream. This method is useful for debugging. Unit list(out: PrintWriter!) Prints this property list out to the specified output stream. This method is useful for debugging. Unit load(reader: Reader!) Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format. Properties are processed in terms of lines. There are two kinds of line, natural lines and logical lines. A natural line is defined as a line of characters that is terminated either by a set of line terminator characters (\n or \r or \r\n) or by the end of the stream. A natural line may be either a blank line, a comment line, or hold all or some of a key-element pair. A logical line holds all the data of a key-element pair, which may be spread out across several adjacent natural lines by escaping the line terminator sequence with a backslash character \. Note that a comment line cannot be extended in this manner; every natural line that is a comment must have its own comment indicator, as described below. Lines are read from input until the end of the stream is reached. A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this format considers the characters space (' ', '\u005Cu0020'), tab ('\t', '\u005Cu0009'), and form feed ('\f', '\u005Cu000C') to be white space. If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start of the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing (when loading) will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to decide if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing. The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example, \:\= would be the two-character key ":=". Line terminator characters can be included using \r and \n escape sequences. Any white space after the key is skipped; if the first non-white space character after the key is '=' or ':', then it is ignored and any white space characters after it are also skipped. All remaining characters on the line become part of the associated element string; if there are no remaining characters, the element is the empty string "". Once the raw character sequences constituting the key and element are identified, escape processing is performed as described above. As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty": Truth = Beauty Truth:Beauty Truth :Beauty As another example, the following three lines specify a single property: fruits apple, banana, pear, \ cantaloupe, watermelon, \ kiwi, mango The key is "fruits" and the associated element is: "apple, banana, pear, cantaloupe, watermelon, kiwi, mango" Note that a space appears before each \ so that a space will appear after each comma in the final result; the \, line terminator, and leading white space on the continuation line are merely discarded and are not replaced by one or more other characters. As a third example, the line: cheeses specifies that the key is "cheeses" and the associated element is the empty string "". Characters in keys and elements can be represented in escape sequences similar to those used for character and string literals (see sections {@jls 3.3} and {@jls 3.10.6} of The Java Language Specification). The differences from the character escape sequences and Unicode escapes used for characters and strings are: Octal escapes are not recognized. The character sequence \b does not represent a backspace character. The method does not treat a backslash character, \, before a non-valid escape character as an error; the backslash is silently dropped. For example, in a Java string the sequence "\z" would cause a compile time error. In contrast, this method silently drops the backslash. Therefore, this method treats the two character sequence "\b" as equivalent to the single character 'b'. Escapes are not necessary for single and double quotes; however, by the rule above, single and double quote characters preceded by a backslash still yield single and double quote characters, respectively. Only a single 'u' character is allowed in a Unicode escape sequence. The specified stream remains open after this method returns. Unit loadFromXML(in: InputStream!) Loads all of the properties represented by the XML document on the specified input stream into this properties table. The XML document must have the following DOCTYPE declaration: <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> Furthermore, the document must satisfy the properties DTD described above. An implementation is required to read XML documents that use the "UTF-8" or "UTF-16" encoding. An implementation may support additional encodings. The specified stream is closed after this method returns. Enumeration<*>! propertyNames() Returns an enumeration of all the keys in this property list, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list. Unit rehash() Unit save(out: OutputStream!, comments: String!) Calls the store(OutputStream out, String comments) method and suppresses IOExceptions that were thrown. Any! setProperty(key: String!, value: String!) Calls the Hashtable method put. Provided for parallelism with the getProperty method. Enforces use of strings for property keys and values. The value returned is the result of the Hashtable call to put. Unit store(out: OutputStream!, comments: String!) Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load(InputStream) method. Properties from the defaults table of this Properties table (if any) are not written out by this method. This method outputs the comments, properties keys and values in the same format as specified in store(Writer), with the following differences: The stream is written using the ISO 8859-1 character encoding. Characters not in Latin-1 in the comments are written as \u005Cuxxxx for their appropriate unicode hexadecimal value xxxx. Characters less than \u005Cu0020 and characters greater than \u005Cu007E in property keys or values are written as \u005Cuxxxx for the appropriate hexadecimal value xxxx. After the entries have been written, the output stream is flushed. The output stream remains open after this method returns. Unit store(writer: Writer!, comments: String!) Writes this property list (key and element pairs) in this Properties table to the output character stream in a format suitable for using the load(Reader) method. Properties from the defaults table of this Properties table (if any) are not written out by this method. If the comments argument is not null, then an ASCII character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment. Any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed in comments is replaced by a line separator generated by the Writer and if the next character in comments is not character or character ! then an ASCII is written out after that line separator. Next, a comment line is always written, consisting of an ASCII character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer. Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. For the key, all space characters are written with a preceding \ character. For the element, leading space characters, but not embedded or trailing space characters, are written with a preceding \ character. The key and element characters , !, =, and : are written with a preceding backslash to ensure that they are properly loaded. After the entries have been written, the output stream is flushed. The output stream remains open after this method returns. Unit storeToXML(os: OutputStream!, comment: String!) Emits an XML document representing all of the properties contained in this table. An invocation of this method of the form props.storeToXML(os, comment) behaves in exactly the same way as the invocation props.storeToXML(os, comment, "UTF-8");. Unit storeToXML(os: OutputStream!, comment: String!, encoding: String!) Emits an XML document representing all of the properties contained in this table, using the specified encoding. The XML document will have the following DOCTYPE declaration: <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> If the specified comment is null then no comment will be stored in the document. An implementation is required to support writing of XML documents that use the "UTF-8" or "UTF-16" encoding. An implementation may support additional encodings. The specified stream remains open after this method returns. This method behaves the same as storeToXML(java.io.OutputStream,java.lang.String,java.nio.charset.Charset) except that it will look up the charset using the given encoding name. Unit storeToXML(os: OutputStream!, comment: String!, charset: Charset!) Emits an XML document representing all of the properties contained in this table, using the specified encoding. The XML document will have the following DOCTYPE declaration: <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> If the specified comment is null then no comment will be stored in the document. An implementation is required to support writing of XML documents that use the "UTF-8" or "UTF-16" encoding. An implementation may support additional encodings. Unmappable characters for the specified charset will be encoded as numeric character references. The specified stream remains open after this method returns. MutableSet<String!>! stringPropertyNames() Returns an unmodifiable set of keys from this property list where the key and its corresponding value are strings, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list. Properties whose key or value is not of type String are omitted. The returned set is not backed by this Properties object. Changes to this Properties object are not reflected in the returned set.

Properties
open MutableSet<MutableEntry<Any!, Any!>>	entries Returns an unmodifiable Set view of the property entries contained in this Provider.
open MutableSet<Any!>	keys Returns an unmodifiable Set view of the property keys contained in this provider.
open MutableCollection<Any!>	values Returns an unmodifiable Collection view of the property values contained in this provider.

Inherited properties
From class Properties Properties! defaults A property list that contains default values for any keys not found in this property list. Int size

Protected constructors

Provider

Added in API level 1

protected Provider(
    name: String!, 
    version: Double, 
    info: String!)

Constructs a provider with the specified name, version number, and information.

Parameters
name	String!: the provider name.
version	Double: the provider version number.
info	String!: a description of the provider and its services.

Public methods

clear

Added in API level 1

open fun clear(): Unit

Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider.

If a security manager is enabled, its checkSecurityAccess method is called with the string "clearProviderProperties."+name (where name is the provider name) to see if it's ok to clear this provider.

Exceptions
java.lang.UnsupportedOperationException	if the clear operation is not supported by this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to clear this provider

compute

Added in API level 24

open fun compute(
    key: Any!, 
    remappingFunction: BiFunction<in Any!, in Any?, *>
): Any?

Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).

If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.

Parameters
key	Any!: key with which the specified value is to be associated
remappingFunction	BiFunction<in Any!, in Any?, *>: the remapping function to compute a value

Return
Any?	the new value associated with the specified key, or null if none

Exceptions
java.lang.NullPointerException	if the specified key is null and this map does not support null keys, or the remappingFunction is null
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.util.ConcurrentModificationException	if it is detected that the remapping function modified this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values or remove properties.

computeIfAbsent

Added in API level 24

open fun computeIfAbsent(
    key: Any!, 
    mappingFunction: Function<in Any!, *>
): Any!

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.

Parameters
key	Any!: key with which the specified value is to be associated
mappingFunction	Function<in Any!, *>: the mapping function to compute a value

Return
Any!	the current (existing or computed) value associated with the specified key, or null if the computed value is null

Exceptions
java.lang.NullPointerException	if the specified key is null and this map does not support null keys, or the mappingFunction is null
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.util.ConcurrentModificationException	if it is detected that the mapping function modified this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values and remove properties.

computeIfPresent

Added in API level 24

open fun computeIfPresent(
    key: Any!, 
    remappingFunction: BiFunction<in Any!, in Any, *>
): Any?

If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.

If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.

Parameters
key	Any!: key with which the specified value is to be associated
remappingFunction	BiFunction<in Any!, in Any, *>: the remapping function to compute a value

Return
Any?	the new value associated with the specified key, or null if none

Exceptions
java.lang.NullPointerException	if the specified key is null and this map does not support null keys, or the remappingFunction is null
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.util.ConcurrentModificationException	if it is detected that the remapping function modified this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values or remove properties.

elements

Added in API level 1

open fun elements(): Enumeration<Any!>!

Return
Enumeration<Any!>!	an enumeration of the values in this hashtable.

forEach

Added in API level 24

open fun forEach(action: BiConsumer<in Any!, in Any!>): Unit

Parameters
action	BiConsumer<in Any!, in Any!>: The action to be performed for each entry

Exceptions
java.lang.NullPointerException	if the specified action is null
java.util.ConcurrentModificationException	if an entry is found to be removed during iteration

get

Added in API level 1

open fun get(key: Any!): Any?

Parameters
key	Any!: the key whose associated value is to be returned

Return
Any?	the value to which the specified key is mapped, or null if this map contains no mapping for the key

Exceptions
java.lang.NullPointerException	if the specified key is null
java.lang.ClassCastException	if the key is of an inappropriate type for this map (java.util.Collection#)

getInfo

Added in API level 1

open fun getInfo(): String!

Returns a human-readable description of the provider and its services. This may return an HTML page, with relevant links.

Return
String!	a description of the provider and its services.

getName

Added in API level 1

open fun getName(): String!

Returns the name of this provider.

Return
String!	the name of this provider.

getOrDefault

Added in API level 24

open fun getOrDefault(
    key: Any!, 
    defaultValue: Any!
): Any!

Parameters
key	Any!: the key whose associated value is to be returned
defaultValue	Any!: the default mapping of the key

Return
Any!	the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key

Exceptions
java.lang.ClassCastException	if the key is of an inappropriate type for this map (java.util.Collection#)
java.lang.NullPointerException	if the specified key is null and this map does not permit null keys (java.util.Collection#)

getProperty

Added in API level 1

open fun getProperty(key: String!): String!

Parameters
key	String!: the property key.

Return
String!	the value in this property list with the specified key value.

getService

Added in API level 1

open fun getService(
    type: String!, 
    algorithm: String!
): Provider.Service!

Get the service describing this Provider's implementation of the specified type of this algorithm or alias. If no such implementation exists, this method returns null. If there are two matching services, one added to this provider using putService() and one added via #put, the service added via putService() is returned.

Parameters
type	String!: the type of service requested (for example, MessageDigest)
algorithm	String!: the case insensitive algorithm name (or alternate alias) of the service requested (for example, SHA-1)

Return
Provider.Service!	the service describing this Provider's matching service or null if no such service exists

Exceptions
java.lang.NullPointerException	if type or algorithm is null

getServices

Added in API level 1

open fun getServices(): MutableSet<Provider.Service!>!

Get an unmodifiable Set of all services supported by this Provider.

Return
MutableSet<Provider.Service!>!	an unmodifiable Set of all services supported by this Provider

getVersion

Added in API level 1

open fun getVersion(): Double

Returns the version number for this provider.

Return
Double	the version number for this provider.

keys

Added in API level 1

open fun keys(): Enumeration<Any!>!

Return
Enumeration<Any!>!	an enumeration of the keys in this hashtable.

load

Added in API level 1

open fun load(inStream: InputStream!): Unit

Reads a property list (key and element pairs) from the input stream.

Parameters
inStream	InputStream!: the input stream.

Exceptions
java.io.IOException	if an error occurred when reading from the input stream.
java.lang.IllegalArgumentException	if the input stream contains a malformed Unicode escape sequence.
java.lang.NullPointerException	if inStream is null.
java.io.IOException	if an error occurred when reading from the input stream.

See Also

merge

Added in API level 24

open fun merge(
    key: Any!, 
    value: Any, 
    remappingFunction: BiFunction<in Any, in Any, *>
): Any?

If the specified key is not already associated with a value or is associated with null, associates it with the given value. Otherwise, replaces the value with the results of the given remapping function, or removes if the result is null. This method may be of use when combining multiple mapped values for a key.

If a security manager is enabled, its checkSecurityAccess method is called with the strings "putProviderProperty."+name and "removeProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.

Parameters
key	Any!: key with which the resulting value is to be associated
value	Any: the non-null value to be merged with the existing value associated with the key or, if no existing value or a null value is associated with the key, to be associated with the key
remappingFunction	BiFunction<in Any, in Any, *>: the remapping function to recompute a value if present

Return
Any?	the new value associated with the specified key, or null if no value is associated with the key

Exceptions
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.NullPointerException	if the specified key is null and this map does not support null keys or the value or remappingFunction is null
java.util.ConcurrentModificationException	if it is detected that the remapping function modified this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values or remove properties.

put

Added in API level 1

open fun put(
    key: Any!, 
    value: Any!
): Any?

Sets the key property to have the specified value.

If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.

Parameters
key	Any!: the hashtable key
value	Any!: the value

Return
Any?	the previous value of the specified key in this hashtable, or null if it did not have one

Exceptions
java.lang.NullPointerException	if the key or value is null
java.lang.UnsupportedOperationException	if the put operation is not supported by this map
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.

putAll

Added in API level 1

open fun putAll(from: Map<*, *>): Unit

Copies all of the mappings from the specified Map to this provider. These mappings will replace any properties that this provider had for any of the keys currently in the specified Map.

Parameters
m	mappings to be stored in this map
t	mappings to be stored in this map

Exceptions
java.lang.UnsupportedOperationException	if the putAll operation is not supported by this map
java.lang.ClassCastException	if the class of a key or value in the specified map prevents it from being stored in this map
java.lang.NullPointerException	if the specified map is null
java.lang.IllegalArgumentException	if some property of a key or value in the specified map prevents it from being stored in this map

putIfAbsent

Added in API level 24

open fun putIfAbsent(
    key: Any!, 
    value: Any!
): Any?

If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.

If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.

Parameters
key	Any!: key with which the specified value is to be associated
value	Any!: value to be associated with the specified key

Return
Any?	the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)

Exceptions
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the key or value is of an inappropriate type for this map (java.util.Collection#)
java.lang.NullPointerException	if the specified key or value is null, and this map does not permit null keys or values (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.

remove

Added in API level 1

open fun remove(key: Any!): Any?

Removes the key property (and its corresponding value).

If a security manager is enabled, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties.

Parameters
key	Any!: the key that needs to be removed

Return
Any?	the value to which the key had been mapped in this hashtable, or null if the key did not have a mapping

Exceptions
java.lang.NullPointerException	if the key is null
java.lang.UnsupportedOperationException	if the remove operation is not supported by this map
java.lang.ClassCastException	if the key is of an inappropriate type for this map (java.util.Collection#)
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to remove this provider's properties.

remove

Added in API level 24

open fun remove(
    key: Any!, 
    value: Any!
): Boolean

Removes the entry for the specified key only if it is currently mapped to the specified value.

If a security manager is enabled, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties.

Parameters
key	Any!: key with which the specified value is associated
value	Any!: value expected to be associated with the specified key

Return
Boolean	true if the value was removed

Exceptions
java.lang.UnsupportedOperationException	if the remove operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the key or value is of an inappropriate type for this map (java.util.Collection#)
java.lang.NullPointerException	if the specified key or value is null, and this map does not permit null keys or values (java.util.Collection#)
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to remove this provider's properties.

replace

Added in API level 24

open fun replace(
    key: Any!, 
    value: Any!
): Any?

Replaces the entry for the specified key only if it is currently mapped to some value.

If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.

Parameters
key	Any!: key with which the specified value is associated
value	Any!: value to be associated with the specified key

Return
Any?	the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)

Exceptions
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of the specified key or value prevents it from being stored in this map (java.util.Collection#)
java.lang.NullPointerException	if the specified key or value is null, and this map does not permit null keys or values
java.lang.IllegalArgumentException	if some property of the specified key or value prevents it from being stored in this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.

replace

Added in API level 24

open fun replace(
    key: Any!, 
    oldValue: Any!, 
    newValue: Any!
): Boolean

Replaces the entry for the specified key only if currently mapped to the specified value.

If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.

Parameters
key	Any!: key with which the specified value is associated
oldValue	Any!: value expected to be associated with the specified key
newValue	Any!: value to be associated with the specified key

Return
Boolean	true if the value was replaced

Exceptions
java.lang.UnsupportedOperationException	if the put operation is not supported by this map (java.util.Collection#)
java.lang.ClassCastException	if the class of a specified key or value prevents it from being stored in this map
java.lang.NullPointerException	if oldValue is null and this map does not permit null values (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of a specified key or value prevents it from being stored in this map
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.

replaceAll

Added in API level 24

open fun replaceAll(function: BiFunction<in Any!, in Any!, *>): Unit

Replaces each entry's value with the result of invoking the given function on that entry, in the order entries are returned by an entry set iterator, until all entries have been processed or the function throws an exception.

If a security manager is enabled, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values.

Parameters
function	BiFunction<in Any!, in Any!, *>: the function to apply to each entry

Exceptions
java.lang.UnsupportedOperationException	if the set operation is not supported by this map's entry set iterator.
java.lang.ClassCastException	if the class of a replacement value prevents it from being stored in this map (java.util.Collection#)
java.lang.NullPointerException	if the specified function is null, or if a replacement value is null and this map does not permit null values (java.util.Collection#)
java.lang.IllegalArgumentException	if some property of a replacement value prevents it from being stored in this map (java.util.Collection#)
java.util.ConcurrentModificationException	if an entry is found to be removed during iteration
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.

toString

Added in API level 1

open fun toString(): String

Returns a string with the name and the version number of this provider.

Return
String	the string with the name and the version number for this provider.

Protected methods

putService

Added in API level 1

protected open fun putService(s: Provider.Service!): Unit

Add a service. If a service of the same type with the same algorithm name exists and it was added using putService(), it is replaced by the new service. This method also places information about this service in the provider's Hashtable values in the format described in the Java Cryptography Architecture API Specification & Reference .

Also, if there is a security manager, its checkSecurityAccess method is called with the string "putProviderProperty."+name, where name is the provider name, to see if it's ok to set this provider's property values. If the default implementation of checkSecurityAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a SecurityPermission("putProviderProperty."+name) permission.

Parameters
s	Provider.Service!: the Service to add

Exceptions
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to set property values.
java.lang.NullPointerException	if s is null

removeService

Added in API level 1

protected open fun removeService(s: Provider.Service!): Unit

Remove a service previously added using putService(). The specified service is removed from this provider. It will no longer be returned by getService() and its information will be removed from this provider's Hashtable.

Also, if there is a security manager, its checkSecurityAccess method is called with the string "removeProviderProperty."+name, where name is the provider name, to see if it's ok to remove this provider's properties. If the default implementation of checkSecurityAccess is used (that is, that method is not overriden), then this results in a call to the security manager's checkPermission method with a SecurityPermission("removeProviderProperty."+name) permission.

Parameters
s	Provider.Service!: the Service to be removed

Exceptions
java.lang.SecurityException	if a security manager exists and its java.lang.SecurityManager#checkSecurityAccess method denies access to remove this provider's properties.
java.lang.NullPointerException	if s is null

Properties

entries

Added in API level 1

open val entries: MutableSet<MutableEntry<Any!, Any!>>

Returns an unmodifiable Set view of the property entries contained in this Provider.

Return
MutableSet<MutableEntry<Any!, Any!>>	a set view of the mappings contained in this map

See Also

• java.util.Map.Entry

keys

Added in API level 1

open val keys: MutableSet<Any!>

Returns an unmodifiable Set view of the property keys contained in this provider.

Return
MutableSet<Any!>	a set view of the keys contained in this map

values

Added in API level 1

open val values: MutableCollection<Any!>

Returns an unmodifiable Collection view of the property values contained in this provider.

Return
MutableCollection<Any!>	a collection view of the values contained in this map