public abstract class

Provider

extends Properties

java.lang.Object
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<K, V>
		↳	java.util.Properties
			↳	java.security.Provider

Known Direct Subclasses

AuthProvider, Provider, Sun, SunJCE, SunJSSE, SunNativeProvider, SunPCSC, SunProvider, SunRsaSign, VerificationProvider

Known Indirect Subclasses

SunPKCS11

Class Overview

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:

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
class	Provider.Service	The description of a security service.

[Expand]

Inherited Fields

From class java.util.Properties

Protected Constructors
	Provider(String name, double version, String info) Constructs a provider with the specified name, version number, and information.

Public Methods
synchronized void	clear() Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider.
Enumeration<Object>	elements() Returns an enumeration of the values in this hashtable.
synchronized Set<Entry<Object, Object>>	entrySet() Returns an unmodifiable Set view of the property entries contained in this Provider.
Object	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
String	getInfo() Returns a human-readable description of the provider and its services.
String	getName() Returns the name of this provider.
String	getProperty(String key) Searches for the property with the specified key in this property list.
synchronized Provider.Service	getService(String type, String algorithm) Get the service describing this Provider's implementation of the specified type of this algorithm or alias.
synchronized Set<Provider.Service>	getServices() Get an unmodifiable Set of all services supported by this Provider.
double	getVersion() Returns the version number for this provider.
Set<Object>	keySet() Returns an unmodifiable Set view of the property keys contained in this provider.
Enumeration<Object>	keys() Returns an enumeration of the keys in this hashtable.
synchronized void	load(InputStream inStream) Reads a property list (key and element pairs) from the input stream.
synchronized Object	put(Object key, Object value) Sets the `key` property to have the specified `value`.
synchronized void	putAll(Map<?, ?> t) Copies all of the mappings from the specified Map to this provider.
synchronized Object	remove(Object key) Removes the `key` property (and its corresponding `value`).
String	toString() Returns a string with the name and the version number of this provider.
Collection<Object>	values() Returns an unmodifiable Collection view of the property values contained in this provider.

Protected Methods
synchronized void	putService(Provider.Service s) Add a service.
synchronized void	removeService(Provider.Service s) Remove a service previously added using `putService()`.

[Expand]

Inherited Methods

From class java.util.Properties

String	getProperty(String key, String defaultValue) Searches for the property with the specified key in this property list.
String	getProperty(String key) Searches for the property with the specified key in this property list.
void	list(PrintStream out) Prints this property list out to the specified output stream.
void	list(PrintWriter out) Prints this property list out to the specified output stream.
synchronized void	load(InputStream inStream) Reads a property list (key and element pairs) from the input byte stream.
synchronized void	load(Reader reader) Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format.
synchronized void	loadFromXML(InputStream in) Loads all of the properties represented by the XML document on the specified input stream into this properties table.
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.
synchronized void	save(OutputStream out, String comments) This method is deprecated. This method does not throw an IOException if an I/O error occurs while saving the property list. The preferred way to save a properties list is via the `store(OutputStream out, String comments)` method or the `storeToXML(OutputStream os, String comment)` method.
synchronized Object	setProperty(String key, String value) Calls the `Hashtable` method `put`.
void	store(OutputStream out, String comments) 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.
void	store(Writer writer, String comments) 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.
synchronized void	storeToXML(OutputStream os, String comment, String encoding) Emits an XML document representing all of the properties contained in this table, using the specified encoding.
synchronized void	storeToXML(OutputStream os, String comment) Emits an XML document representing all of the properties contained in this table.
Set<String>	stringPropertyNames() Returns a set of keys in 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.

From class java.util.Hashtable

synchronized void	clear() Clears this hashtable so that it contains no keys.
synchronized Object	clone() Creates a shallow copy of this hashtable.
synchronized boolean	contains(Object value) Tests if some key maps into the specified value in this hashtable.
synchronized boolean	containsKey(Object key) Tests if the specified object is a key in this hashtable.
boolean	containsValue(Object value) Returns true if this hashtable maps one or more keys to this value.
synchronized Enumeration<V>	elements() Returns an enumeration of the values in this hashtable.
Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
synchronized boolean	equals(Object o) Compares the specified Object with this Map for equality, as per the definition in the Map interface.
synchronized V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
synchronized int	hashCode() Returns the hash code value for this Map as per the definition in the Map interface.
synchronized boolean	isEmpty() Tests if this hashtable maps no keys to values.
Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
synchronized Enumeration<K>	keys() Returns an enumeration of the keys in this hashtable.
synchronized V	put(K key, V value) Maps the specified `key` to the specified `value` in this hashtable.
synchronized void	putAll(Map<? extends K, ? extends V> t) Copies all of the mappings from the specified map to this hashtable.
void	rehash() Increases the capacity of and internally reorganizes this hashtable, in order to accommodate and access its entries more efficiently.
synchronized V	remove(Object key) Removes the key (and its corresponding value) from this hashtable.
synchronized int	size() Returns the number of keys in this hashtable.
synchronized String	toString() Returns a string representation of this `Hashtable` object in the form of a set of entries, enclosed in braces and separated by the ASCII characters "`,` " (comma and space).
Collection<V>	values() Returns a `Collection` view of the values contained in this map.

From class java.util.Dictionary

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.util.Map

abstract void	clear() Removes all of the mappings from this map (optional operation).
abstract boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key.
abstract boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
abstract boolean	equals(Object o) Compares the specified object with this map for equality.
abstract V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
abstract int	hashCode() Returns the hash code value for this map.
abstract boolean	isEmpty() Returns `true` if this map contains no key-value mappings.
abstract Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
abstract V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
abstract void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
abstract V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).
abstract int	size() Returns the number of key-value mappings in this map.
abstract Collection<V>	values() Returns a `Collection` view of the values contained in this map.

Protected Constructors

protected Provider (String name, double version, String info)

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

Parameters

name	the provider name.
version	the provider version number.
info	a description of the provider and its services.

Public Methods

public synchronized void clear ()

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

First, if there is a security manager, 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. 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("clearProviderProperties."+name) permission.

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess(String)` method denies access to clear this provider

public Enumeration<Object> elements ()

Returns an enumeration of the values in this hashtable. Use the Enumeration methods on the returned object to fetch the elements sequentially.

Returns

an enumeration of the values in this hashtable.

public synchronized Set<Entry<Object, Object>> entrySet ()

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

Returns

a set view of the mappings contained in this map

public Object get (Object key)

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.)

Parameters

key	the key whose associated value is to be returned

Returns

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

public String 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.

public String getName ()

Returns the name of this provider.

Returns

the name of this provider.

public String getProperty (String key)

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.

Parameters

key	the property key.

Returns

the value in this property list with the specified key value.

public synchronized 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.

Parameters

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`)

Returns

the service describing this Provider's matching service or null if no such service exists

Throws

NullPointerException	if type or algorithm is null

public synchronized Set<Provider.Service> getServices ()

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

Returns

an unmodifiable Set of all services supported by this Provider

public double getVersion ()

Returns the version number for this provider.

Returns

the version number for this provider.

public Set<Object> keySet ()

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

Returns

a set view of the keys contained in this map

public Enumeration<Object> keys ()

Returns an enumeration of the keys in this hashtable.

Returns

an enumeration of the keys in this hashtable.

public synchronized void load (InputStream inStream)

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

Parameters

inStream	the input stream.

Throws

IOException	if an error occurred when reading from the input stream.

public synchronized Object put (Object key, Object value)

Sets the key property to have the specified value.

First, 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

key	the property key.
value	the property value.

Returns

the previous value of the specified property (key), or null if it did not have one.

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess(String)` method denies access to set property values.

public synchronized 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.

Parameters

t	mappings to be stored in this map

public synchronized Object remove (Object key)

Removes the key property (and its corresponding value).

First, 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

key	the key for the property to be removed.

Returns

the value to which the key had been mapped, or null if the key did not have a mapping.

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess(String)` method denies access to remove this provider's properties.

public String toString ()

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

Returns

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

public Collection<Object> values ()

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

Returns

a collection view of the values contained in this map

Protected Methods

protected synchronized 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.

Parameters

s	the Service to add

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess(String)` method denies access to set property values.
NullPointerException	if s is null

protected synchronized 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.

Parameters

s	the Service to be removed

Throws

SecurityException	if a security manager exists and its `checkSecurityAccess(String)` method denies access to remove this provider's properties.
NullPointerException	if s is null

Interfaces

Classes

Enums

Exceptions

Provider

Class Overview

Summary

Protected Constructors

protected Provider (String name, double version, String info)

Parameters

Public Methods

public synchronized void clear ()

Throws

public Enumeration<Object> elements ()

Returns

public synchronized Set<Entry<Object, Object>> entrySet ()

Returns

See Also

public Object get (Object key)

Parameters

Returns

public String getInfo ()

Returns

public String getName ()

Returns

public String getProperty (String key)

Parameters

Returns

public synchronized Provider.Service getService (String type, String algorithm)

Parameters

Returns

Throws

public synchronized Set<Provider.Service> getServices ()

Returns

public double getVersion ()

Returns

public Set<Object> keySet ()

Returns

public Enumeration<Object> keys ()

Returns

public synchronized void load (InputStream inStream)

Parameters

Throws

See Also

public synchronized Object put (Object key, Object value)

Parameters

Returns

Throws

public synchronized void putAll (Map<?, ?> t)

Parameters

public synchronized Object remove (Object key)

Parameters

Returns

Throws

public String toString ()

Returns

public Collection<Object> values ()

Returns

Protected Methods

protected synchronized void putService (Provider.Service s)

Parameters

Throws

protected synchronized void removeService (Provider.Service s)

Parameters

Throws