Serializable
, Cloneable
, Map<Object,Object>
AuthProvider
public abstract class Provider extends Properties
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.
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.
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.getVersionStr()) |
Provider.id info | String.valueOf(provider.getInfo()) |
Provider.id className | provider.getClass().getName() |
Each provider has a name and a version string. A provider normally identifies itself with a file named java.security.Provider
in the resource directory META-INF/services
. Security providers are looked up via the ServiceLoader
mechanism using the application class loader
.
Providers may be configured such that they are automatically installed and made available at runtime via the Security.getProviders()
method. The mechanism for configuring and installing security providers is implementation-specific.
conf/security/java.security
file in the Java installation directory. These providers are automatically installed by the JDK runtime, see The Provider Class in the Java Cryptography Architecture (JCA) Reference Guide for information about how a particular type of provider, the cryptographic service provider, works and is installed.Modifier and Type | Class | Description |
---|---|---|
static class |
Provider.Service |
The description of a security service. |
defaults
Modifier | Constructor | Description |
---|---|---|
protected |
Deprecated. |
|
protected |
Constructs a Provider with the specified name, version string, and information. |
Modifier and Type | Method | Description |
---|---|---|
void |
clear() |
Clears this Provider so that it no longer contains the properties used to look up facilities implemented by the Provider . |
Object |
compute |
Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping). |
Object |
computeIfAbsent |
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 . |
Object |
computeIfPresent |
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. |
Provider |
configure |
Apply the supplied configuration argument to this Provider instance and return the configured Provider . |
Set |
entrySet() |
Returns an unmodifiable Set view of the property entries contained in this Provider . |
void |
forEach |
Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. |
String |
getInfo() |
Returns a human-readable description of the Provider and its services. |
String |
getName() |
Returns the name of this Provider . |
Object |
getOrDefault |
Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key. |
Provider.Service |
getService |
Get the service describing this Provider's implementation of the specified type of this algorithm or alias. |
Set |
getServices() |
Get an unmodifiable Set of all services supported by this Provider . |
double |
getVersion() |
Deprecated. use getVersionStr() instead. |
String |
getVersionStr() |
Returns the version string for this Provider . |
boolean |
isConfigured() |
Check if this Provider instance has been configured. |
Set |
keySet() |
Returns an unmodifiable Set view of the property keys contained in this Provider . |
void |
load |
Reads a property list (key and element pairs) from the input stream. |
Object |
merge |
If the specified key is not already associated with a value or is associated with null , associates it with the given value. |
Object |
put |
Sets the key property to have the specified value . |
void |
putAll |
Copies all the mappings from the specified Map to this Provider . |
Object |
putIfAbsent |
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. |
protected void |
putService |
Add a service. |
Object |
remove |
Removes the key property (and its corresponding value ). |
boolean |
remove |
Removes the entry for the specified key only if it is currently mapped to the specified value. |
protected void |
removeService |
Remove a service previously added using putService() . |
Object |
replace |
Replaces the entry for the specified key only if it is currently mapped to some value. |
boolean |
replace |
Replaces the entry for the specified key only if currently mapped to the specified value. |
void |
replaceAll |
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. |
String |
toString() |
Returns a string with the name and the version string of this Provider . |
Collection |
values() |
Returns an unmodifiable Collection view of the property values contained in this Provider . |
getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames
@Deprecated(since="9") protected Provider(String name, double version, String info)
Provider(String, String, String)
instead.Provider
with the specified name, version number, and information. Calling this constructor is equivalent to call the Provider(String, String, String)
with name
name, Double.toString(version)
, and info
.name
- the provider name.version
- the provider version number.info
- a description of the provider and its services.protected Provider(String name, String versionStr, String info)
Provider
with the specified name, version string, and information. The version string contains a version number optionally followed by other information separated by one of the characters of '+', '-'. The format for the version number is:
^[0-9]+(\.[0-9]+)*
In order to return the version number in a double, when there are more than two components (separated by '.' as defined above), only the first two components are retained. The resulting string is then passed to Double.valueOf(String)
to generate version number, i.e. getVersion()
.
If the conversion failed, value 0 will be used.
name
- the provider name.versionStr
- the provider version string.info
- a description of the provider and its services.public Provider configure(String configArg)
Provider
instance and return the configured Provider
. Note that if this Provider
cannot be configured in-place, a new Provider
will be created and returned. Therefore, callers should always use the returned Provider
.UnsupportedOperationException
. Subclasses should override this method only if a configuration argument is supported.configArg
- the configuration information for configuring this provider.Provider
configured with the supplied configuration argument.UnsupportedOperationException
- if a configuration argument is not supported.NullPointerException
- if the supplied configuration argument is null
.InvalidParameterException
- if the supplied configuration argument is invalid.public boolean isConfigured()
Provider
instance has been configured.true
. Subclasses should override this method if the Provider
requires an explicit configure
call after being constructed.true
if no further configuration is needed, false
otherwise.public String getName()
Provider
.Provider
.@Deprecated(since="9") public double getVersion()
getVersionStr()
instead.Provider
.Provider
.public String getVersionStr()
Provider
.Provider
.public String getInfo()
Provider
and its services. This may return an HTML page, with relevant links.Provider
and its services.public String toString()
Provider
.public void clear()
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
load
in class Properties
inStream
- the input stream.IOException
- if an error occurred when reading from the input stream.public void putAll(Map<?,?> t)
Provider
. These mappings will replace any properties that this Provider
had for any of the keys currently in the specified Map.public Set<Map.Entry<Object,Object>> entrySet()
Provider
.public Set<Object> keySet()
Provider
.public Collection<Object> values()
Provider
.public Object put(Object key, Object value)
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.public Object putIfAbsent(Object key, Object value)
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.
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)
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)
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.
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)
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.
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)
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.
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)
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.
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)
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 remapping 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)
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 mapping 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 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 remapping 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)
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 remapping 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 getOrDefault(Object key, Object defaultValue)
Map
defaultValue
if this map contains no mapping for the key.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)
Map
action
- The action to be performed for each entrypublic Provider.Service getService(String type, String algorithm)
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
)null
if no such service existsNullPointerException
- if type or algorithm is null
public Set<Provider.Service> getServices()
Provider
.Provider
protected void putService(Provider.Service s)
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 (JCA) Reference Guide. 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 overridden), 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 null
protected void removeService(Provider.Service s)
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 overridden), 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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/Provider.html
Provider(String, String, String)
instead.