public abstract class Provider extends Properties
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:
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:
| 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() |
| Modifier and Type | Class and Description |
|---|---|
static class |
Provider.Service The description of a security service. |
defaults protected Provider(String name,
double version,
String info) Constructs a provider with the specified name, version number, and information.
name - the provider name.version - the provider version number.info - a description of the provider and its services.public String getName()
Returns the name of this provider.
public double getVersion()
Returns the version number for this provider.
public String getInfo()
Returns a human-readable description of the provider and its services. This may return an HTML page, with relevant links.
public String toString()
Returns a string with the name and the version number of this provider.
toString in class Hashtable<Object,Object>
public void clear()
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.
clear in interface Map<Object,Object>
clear in class Hashtable<Object,Object>
SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to clear this providerpublic void load(InputStream inStream)
throws IOException Reads a property list (key and element pairs) from the input stream.
load in class Properties
inStream - the input stream.IOException - if an error occurred when reading from the input stream.Properties.load(java.io.Reader)public void putAll(Map<?,?> t)
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.
putAll in interface Map<Object,Object>
putAll in class Hashtable<Object,Object>
t - mappings to be stored in this mappublic Set<Map.Entry<Object,Object>> entrySet()
Returns an unmodifiable Set view of the property entries contained in this Provider.
entrySet in interface Map<Object,Object>
entrySet in class Hashtable<Object,Object>
Map.Entrypublic Set<Object> keySet()
Returns an unmodifiable Set view of the property keys contained in this provider.
keySet in interface Map<Object,Object>
keySet in class Hashtable<Object,Object>
public Collection<Object> values()
Returns an unmodifiable Collection view of the property values contained in this provider.
values in interface Map<Object,Object>
values in class Hashtable<Object,Object>
public Object put(Object key,
Object value) 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.
put in interface Map<Object,Object>
put in class Hashtable<Object,Object>
key - the hashtable keyvalue - the valuenull if it did not have oneSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.Object.equals(Object), Hashtable.get(Object)
public Object putIfAbsent(Object key,
Object value) 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.
putIfAbsent in interface Map<Object,Object>
putIfAbsent in class Hashtable<Object,Object>
key - key with which the specified value is to be associatedvalue - value to be associated with the specified keynull 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.)SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.public Object remove(Object key)
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.
remove in interface Map<Object,Object>
remove in class Hashtable<Object,Object>
key - the key that needs to be removednull if the key did not have a mappingSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to remove this provider's properties.public boolean remove(Object key,
Object value) 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.
remove in interface Map<Object,Object>
remove in class Hashtable<Object,Object>
key - key with which the specified value is associatedvalue - value expected to be associated with the specified keytrue if the value was removedSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to remove this provider's properties.public boolean replace(Object key,
Object oldValue,
Object newValue) 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.
replace in interface Map<Object,Object>
replace in class Hashtable<Object,Object>
key - key with which the specified value is associatedoldValue - value expected to be associated with the specified keynewValue - value to be associated with the specified keytrue if the value was replacedSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.public Object replace(Object key,
Object value) 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.
replace in interface Map<Object,Object>
replace in class Hashtable<Object,Object>
key - key with which the specified value is associatedvalue - value to be associated with the specified keynull 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.)SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.public void replaceAll(BiFunction<? super Object,? super Object,? extends Object> function)
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.
replaceAll in interface Map<Object,Object>
replaceAll in class Hashtable<Object,Object>
function - the function to apply to each entrySecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.public Object compute(Object key,
BiFunction<? super Object,? super Object,? extends Object> remappingFunction) 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.
compute in interface Map<Object,Object>
compute in class Hashtable<Object,Object>
key - key with which the specified value is to be associatedremappingFunction - the function to compute a valueSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values or remove properties.public Object computeIfAbsent(Object key,
Function<? super Object,? extends Object> mappingFunction) 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.
computeIfAbsent in interface Map<Object,Object>
computeIfAbsent in class Hashtable<Object,Object>
key - key with which the specified value is to be associatedmappingFunction - the function to compute a valueSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values and remove properties.public Object computeIfPresent(Object key,
BiFunction<? super Object,? super Object,? extends Object> remappingFunction) 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.
computeIfPresent in interface Map<Object,Object>
computeIfPresent in class Hashtable<Object,Object>
key - key with which the specified value is to be associatedremappingFunction - the function to compute a valueSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values or remove properties.public Object merge(Object key,
Object value,
BiFunction<? super Object,? super Object,? extends Object> remappingFunction) 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.
merge in interface Map<Object,Object>
merge in class Hashtable<Object,Object>
key - key with which the resulting value is to be associatedvalue - 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 keyremappingFunction - the function to recompute a value if presentSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values or remove properties.public Object get(Object key)
Description copied from class: Hashtable
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key k to a value v such that (key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)
get in interface Map<Object,Object>
get in class Hashtable<Object,Object>
key - the key whose associated value is to be returnednull if this map contains no mapping for the keyHashtable.put(Object, Object)public Object getOrDefault(Object key,
Object defaultValue) Description copied from interface: Map
Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
getOrDefault in interface Map<Object,Object>
getOrDefault in class Hashtable<Object,Object>
key - the key whose associated value is to be returneddefaultValue - the default mapping of the keydefaultValue if this map contains no mapping for the keypublic void forEach(BiConsumer<? super Object,? super Object> action)
Description copied from interface: Map
Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.
forEach in interface Map<Object,Object>
forEach in class Hashtable<Object,Object>
action - The action to be performed for each entrypublic Enumeration<Object> keys()
Description copied from class: Hashtable
Returns an enumeration of the keys in this hashtable.
keys in class Hashtable<Object,Object>
Enumeration, Hashtable.elements(), Hashtable.keySet(), Map
public Enumeration<Object> elements()
Description copied from class: Hashtable
Returns an enumeration of the values in this hashtable. Use the Enumeration methods on the returned object to fetch the elements sequentially.
elements in class Hashtable<Object,Object>
Enumeration, Hashtable.keys(), Hashtable.values(), Map
public String getProperty(String key)
Description copied from class: Properties
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 null if the property is not found.
getProperty in class Properties
key - the property key.Properties.setProperty(java.lang.String, java.lang.String), Properties.defaults
public Provider.Service getService(String type,
String algorithm) 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.
type - the type of service requested (for example, MessageDigest)algorithm - the case insensitive algorithm name (or alternate alias) of the service requested (for example, SHA-1)NullPointerException - if type or algorithm is nullpublic Set<Provider.Service> getServices()
Get an unmodifiable Set of all services supported by this Provider.
protected void putService(Provider.Service s)
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.
s - the Service to addSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to set property values.NullPointerException - if s is nullprotected void removeService(Provider.Service s)
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.
s - the Service to be removedSecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies access to remove this provider's properties.NullPointerException - if s is null
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.