| java.util.Properties
 java.security.Provider
All known Subclasses: java.security.AuthProvider,
| Provider | | abstract public class Provider extends Properties (Code) | | 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() |
version:
1.84, 05/05/07
author:
Benjamin Renaud
author:
Andreas Sterbenz |
| Inner Class :public static class Service | |
| Constructor Summary | |
| protected | Provider(String name, double version, String info)
Constructs a provider with the specified name, version number,
and information. |
| Method Summary | |
| public synchronized void | clear()
Clears this provider so that it no longer contains the properties
used to look up facilities implemented by the provider. | | public Enumeration<Object> | elements()
| | public synchronized Set<Map.Entry<Object, Object>> | entrySet()
Returns an unmodifiable Set view of the property entries contained
in this Provider. | | public Object | get(Object key)
| | public String | getInfo()
Returns a human-readable description of the provider and its
services. | | public String | getName()
Returns the name of this provider. | | public String | getProperty(String key)
| | public synchronized Service | getService(String type, String algorithm)
Get the service describing this Provider's implementation of the
specified type of this algorithm or alias. | | public synchronized Set<Service> | getServices()
Get an unmodifiable Set of all services supported by
this Provider. | | public double | getVersion()
Returns the version number for this provider. | | public Set<Object> | keySet()
Returns an unmodifiable Set view of the property keys contained in
this provider. | | public Enumeration<Object> | keys()
| | public synchronized void | load(InputStream inStream)
Reads a property list (key and element pairs) 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. | | 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. | | protected synchronized void | putService(Service s)
Add a service. | | 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. | | protected synchronized void | removeService(Service s)
Remove a service previously added using
Provider.putService putService() . | | public String | toString()
Returns a string with the name and the version number
of this provider. | | public Collection<Object> | values()
Returns an unmodifiable Collection view of the property values
contained in this provider. |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| Provider | | protected Provider(String name, double version, String info)(Code) | | Constructs a provider with the specified name, version number,
and information.
Parameters:
name - the provider name.
Parameters:
version - the provider version number.
Parameters:
info - a description of the provider and its services. |
| clear | | public synchronized void clear()(Code) | | 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 java.lang.SecurityManager.checkSecurityAccess method denies access to clear this provider
since:
1.2 |
| entrySet | | public synchronized Set<Map.Entry<Object, Object>> entrySet()(Code) | | Returns an unmodifiable Set view of the property entries contained
in this Provider.
See Also: java.util.Map.Entry
since:
1.2 |
| getInfo | | public String getInfo()(Code) | | Returns a human-readable description of the provider and its
services. This may return an HTML page, with relevant links.
a description of the provider and its services. |
| getName | | public String getName()(Code) | | Returns the name of this provider.
the name of this provider. |
| getService | | public synchronized Service getService(String type, String algorithm)(Code) | | 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
Provider.putService putService() and one added via
Provider.put put() ,
the service added via
Provider.putService putService() is returned.
Parameters:
type - the type of Service service requested(for example, MessageDigest)
Parameters:
algorithm - the case insensitive algorithm name (or alternate alias) of the service requested (for example, SHA-1) the service describing this Provider's matching serviceor null if no such service exists
throws:
NullPointerException - if type or algorithm is null
since:
1.5 |
| getServices | | public synchronized Set<Service> getServices()(Code) | | Get an unmodifiable Set of all services supported by
this Provider.
an unmodifiable Set of all services supported bythis Provider
since:
1.5 |
| getVersion | | public double getVersion()(Code) | | Returns the version number for this provider.
the version number for this provider. |
| keySet | | public Set<Object> keySet()(Code) | | Returns an unmodifiable Set view of the property keys contained in
this provider.
since:
1.2 |
| put | | public synchronized Object put(Object key, Object value)(Code) | | 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.
Parameters:
value - the property value. 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 java.lang.SecurityManager.checkSecurityAccess method denies access to set property values.
since:
1.2 |
| putAll | | public synchronized void putAll(Map t)(Code) | | 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.
since:
1.2 |
| putService | | protected synchronized void putService(Service s)(Code) | | Add a service. If a service of the same type with the same algorithm
name exists and it was added using
Provider.putService 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 java.lang.SecurityManager.checkSecurityAccess method deniesaccess to set property values.
throws:
NullPointerException - if s is null
since:
1.5 |
| remove | | public synchronized Object remove(Object key)(Code) | | 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. 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 java.lang.SecurityManager.checkSecurityAccess method denies access to remove this provider's properties.
since:
1.2 |
| removeService | | protected synchronized void removeService(Service s)(Code) | | Remove a service previously added using
Provider.putService putService() . The specified service is removed from
this provider. It will no longer be returned by
Provider.getService 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 java.lang.SecurityManager.checkSecurityAccess method deniesaccess to remove this provider's properties.
throws:
NullPointerException - if s is null
since:
1.5 |
| toString | | public String toString()(Code) | | Returns a string with the name and the version number
of this provider.
the string with the name and the version numberfor this provider. |
| values | | public Collection<Object> values()(Code) | | Returns an unmodifiable Collection view of the property values
contained in this provider.
since:
1.2 |
|
|