- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Object,
Object>
- Direct Known Subclasses:
AuthProvider
- Algorithms (such as DSA, RSA, or SHA-256).
- Key generation, conversion, and management facilities (such as for algorithm-specific keys).
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.
- Implementation Note:
- The JDK implementation supports static registration of the security
providers via the
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. - Since:
- 1.1
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
The description of a security service. -
Field Summary
Fields declared in class java.util.Properties
defaults
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider.Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).computeIfAbsent
(Object key, Function<? super Object, ? extends Object> mappingFunction) If the specified key is not already associated with a value (or is mapped tonull
), attempts to compute its value using the given mapping function and enters it into this map unlessnull
.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.Apply the supplied configuration argument to this provider instance and return the configured provider.entrySet()
Returns an unmodifiable Set view of the property entries contained in this Provider.void
forEach
(BiConsumer<? super Object, ? super Object> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.getInfo()
Returns a human-readable description of the provider and its services.getName()
Returns the name of this provider.getOrDefault
(Object key, Object defaultValue) Returns the value to which the specified key is mapped, ordefaultValue
if this map contains no mapping for the key.getService
(String type, String algorithm) Get the service describing this Provider's implementation of the specified type of this algorithm or alias.Get an unmodifiable Set of all services supported by this Provider.double
Deprecated.usegetVersionStr()
instead.Returns the version string for this provider.boolean
Check if this provider instance has been configured.keySet()
Returns an unmodifiable Set view of the property keys contained in this provider.void
load
(InputStream inStream) Reads a property list (key and element pairs) from the input stream.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.Sets thekey
property to have the specifiedvalue
.void
Copies all of the mappings from the specified Map to this provider.putIfAbsent
(Object key, Object value) If the specified key is not already associated with a value (or is mapped tonull
) associates it with the given value and returnsnull
, else returns the current value.protected void
Add a service.Removes thekey
property (and its correspondingvalue
).boolean
Removes the entry for the specified key only if it is currently mapped to the specified value.protected void
Remove a service previously added usingputService()
.Replaces the entry for the specified key only if it is currently mapped to some value.boolean
Replaces the entry for the specified key only if currently mapped to the specified value.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.toString()
Returns a string with the name and the version string of this provider.values()
Returns an unmodifiable Collection view of the property values contained in this provider.Methods declared in class java.util.Properties
getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames
-
Constructor Details
-
Provider
Deprecated.useProvider(String, String, String)
instead.Constructs a provider with the specified name, version number, and information. Calling this constructor is equivalent to call theProvider(String, String, String)
withname
name,Double.toString(version)
, andinfo
.- Parameters:
name
- the provider name.version
- the provider version number.info
- a description of the provider and its services.
-
Provider
Constructs a 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.
- Parameters:
name
- the provider name.versionStr
- the provider version string.info
- a description of the provider and its services.- Since:
- 9
-
-
Method Details
-
configure
Apply the supplied configuration argument to this 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.- Implementation Requirements:
- The default implementation throws
UnsupportedOperationException
. Subclasses should override this method only if a configuration argument is supported. - Parameters:
configArg
- the configuration information for configuring this provider.- Returns:
- a provider configured with the supplied configuration argument.
- Throws:
UnsupportedOperationException
- if a configuration argument is not supported.NullPointerException
- if the supplied configuration argument is null.InvalidParameterException
- if the supplied configuration argument is invalid.- Since:
- 9
-
isConfigured
public boolean isConfigured()Check if this provider instance has been configured.- Implementation Requirements:
- The default implementation returns true.
Subclasses should override this method if the provider instance requires
an explicit
configure
call after being constructed. - Returns:
- true if no further configuration is needed, false otherwise.
- Since:
- 9
-
getName
Returns the name of this provider.- Returns:
- the name of this provider.
-
getVersion
Deprecated.usegetVersionStr()
instead.Returns the version number for this provider.- Returns:
- the version number for this provider.
-
getVersionStr
Returns the version string for this provider.- Returns:
- the version string for this provider.
- Since:
- 9
-
getInfo
Returns a human-readable description of the provider and its services. This may return an HTML page, with relevant links.- Returns:
- a description of the provider and its services.
-
toString
Returns a string with the name and the version string of this provider. -
clear
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
(wherename
is the provider name) to see if it's ok to clear this provider.- Specified by:
clear
in interfaceMap<Object,
Object> - Overrides:
clear
in classHashtable<Object,
Object> - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to clear this provider- Since:
- 1.2
-
load
Reads a property list (key and element pairs) from the input stream.- Overrides:
load
in classProperties
- Parameters:
inStream
- the input stream.- Throws:
IOException
- if an error occurred when reading from the input stream.- See Also:
-
putAll
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. -
entrySet
Returns an unmodifiable Set view of the property entries contained in this Provider. -
keySet
Returns an unmodifiable Set view of the property keys contained in this provider. -
values
Returns an unmodifiable Collection view of the property values contained in this provider. -
put
Sets thekey
property to have the specifiedvalue
.If a security manager is enabled, its
checkSecurityAccess
method is called with the string"putProviderProperty."+name
, wherename
is the provider name, to see if it's ok to set this provider's property values.- Specified by:
put
in interfaceMap<Object,
Object> - Overrides:
put
in classHashtable<Object,
Object> - Parameters:
key
- the hashtable keyvalue
- the value- Returns:
- the previous value of the specified key in this hashtable,
or
null
if it did not have one - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.- Since:
- 1.2
- See Also:
-
putIfAbsent
If the specified key is not already associated with a value (or is mapped tonull
) associates it with the given value and returnsnull
, else returns the current value.If a security manager is enabled, its
checkSecurityAccess
method is called with the string"putProviderProperty."+name
, wherename
is the provider name, to see if it's ok to set this provider's property values.- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with the specified key, or
null
if there was no mapping for the key. (Anull
return can also indicate that the map previously associatednull
with the key, if the implementation supports null values.) - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.- Since:
- 1.8
-
remove
Removes thekey
property (and its correspondingvalue
).If a security manager is enabled, its
checkSecurityAccess
method is called with the string"removeProviderProperty."+name
, wherename
is the provider name, to see if it's ok to remove this provider's properties.- Specified by:
remove
in interfaceMap<Object,
Object> - Overrides:
remove
in classHashtable<Object,
Object> - Parameters:
key
- the key that needs to be removed- Returns:
- the value to which the key had been mapped in this hashtable,
or
null
if the key did not have a mapping - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to remove this provider's properties.- Since:
- 1.2
-
remove
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
, wherename
is the provider name, to see if it's ok to remove this provider's properties.- Parameters:
key
- key with which the specified value is associatedvalue
- value expected to be associated with the specified key- Returns:
true
if the value was removed- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to remove this provider's properties.- Since:
- 1.8
-
replace
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
, wherename
is the provider name, to see if it's ok to set this provider's property values.- Parameters:
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 key- Returns:
true
if the value was replaced- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.- Since:
- 1.8
-
replace
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
, wherename
is the provider name, to see if it's ok to set this provider's property values.- Parameters:
key
- key with which the specified value is associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with the specified key, or
null
if there was no mapping for the key. (Anull
return can also indicate that the map previously associatednull
with the key, if the implementation supports null values.) - Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.- Since:
- 1.8
-
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.If a security manager is enabled, its
checkSecurityAccess
method is called with the string"putProviderProperty."+name
, wherename
is the provider name, to see if it's ok to set this provider's property values.- Parameters:
function
- the function to apply to each entry- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.- Since:
- 1.8
-
compute
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 (ornull
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
, wherename
is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.- Specified by:
compute
in interfaceMap<Object,
Object> - Overrides:
compute
in classHashtable<Object,
Object> - Parameters:
key
- key with which the specified value is to be associatedremappingFunction
- the remapping function to compute a value- Returns:
- the new value associated with the specified key, or null if none
- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values or remove properties.- Since:
- 1.8
-
computeIfAbsent
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 tonull
), attempts to compute its value using the given mapping function and enters it into this map unlessnull
.If a security manager is enabled, its
checkSecurityAccess
method is called with the strings"putProviderProperty."+name
and"removeProviderProperty."+name
, wherename
is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.- Specified by:
computeIfAbsent
in interfaceMap<Object,
Object> - Overrides:
computeIfAbsent
in classHashtable<Object,
Object> - Parameters:
key
- key with which the specified value is to be associatedmappingFunction
- the mapping function to compute a value- Returns:
- the current (existing or computed) value associated with the specified key, or null if the computed value is null
- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values and remove properties.- Since:
- 1.8
-
computeIfPresent
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
, wherename
is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.- Specified by:
computeIfPresent
in interfaceMap<Object,
Object> - Overrides:
computeIfPresent
in classHashtable<Object,
Object> - Parameters:
key
- key with which the specified value is to be associatedremappingFunction
- the remapping function to compute a value- Returns:
- the new value associated with the specified key, or null if none
- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values or remove properties.- Since:
- 1.8
-
merge
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
, wherename
is the provider name, to see if it's ok to set this provider's property values and remove this provider's properties.- Specified by:
merge
in interfaceMap<Object,
Object> - Overrides:
merge
in classHashtable<Object,
Object> - Parameters:
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 present- Returns:
- the new value associated with the specified key, or null if no value is associated with the key
- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values or remove properties.- Since:
- 1.8
-
getOrDefault
Description copied from interface:Map
Returns the value to which the specified key is mapped, ordefaultValue
if this map contains no mapping for the key.- Parameters:
key
- the key whose associated value is to be returneddefaultValue
- the default mapping of the key- Returns:
- the value to which the specified key is mapped, or
defaultValue
if this map contains no mapping for the key - Since:
- 1.8
-
forEach
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.- Parameters:
action
- The action to be performed for each entry- Since:
- 1.8
-
getService
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 usingputService()
and one added viaput()
, the service added viaputService()
is returned.- Parameters:
type
- the type ofservice
requested (for example,MessageDigest
)algorithm
- the case insensitive algorithm name (or alternate alias) of the service requested (for example,SHA-1
)- Returns:
- the service describing this Provider's matching service or null if no such service exists
- Throws:
NullPointerException
- if type or algorithm is null- Since:
- 1.5
-
getServices
Get an unmodifiable Set of all services supported by this Provider.- Returns:
- an unmodifiable Set of all services supported by this Provider
- Since:
- 1.5
-
putService
Add a service. If a service of the same type with the same algorithm name exists and it was added usingputService()
, 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
, wherename
is the provider name, to see if it's ok to set this provider's property values. If the default implementation ofcheckSecurityAccess
is used (that is, that method is not overridden), then this results in a call to the security manager'scheckPermission
method with aSecurityPermission("putProviderProperty."+name)
permission.- Parameters:
s
- the Service to add- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to set property values.NullPointerException
- if s is null- Since:
- 1.5
-
removeService
Remove a service previously added usingputService()
. The specified service is removed from this provider. It will no longer be returned bygetService()
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
, wherename
is the provider name, to see if it's ok to remove this provider's properties. If the default implementation ofcheckSecurityAccess
is used (that is, that method is not overridden), then this results in a call to the security manager'scheckPermission
method with aSecurityPermission("removeProviderProperty."+name)
permission.- Parameters:
s
- the Service to be removed- Throws:
SecurityException
- if a security manager exists and itsSecurityManager.checkSecurityAccess(java.lang.String)
method denies access to remove this provider's properties.NullPointerException
- if s is null- Since:
- 1.5
-
Provider(String, String, String)
instead.