| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 {@link 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() |
Nested Class Summary | |
---|---|
static class |
The description of a security service. |
Field Summary |
---|
Fields inherited from class java.util.Properties |
---|
defaults |
Constructor Summary | |
---|---|
protected |
Constructs a provider with the specified name, version number, and information. |
Method Summary | |
---|---|
void |
clear() Clears this provider so that it no longer contains the properties used to look up facilities implemented by the provider. |
Enumeration |
elements() Returns an enumeration of the values in this hashtable. |
Set |
entrySet() Returns an unmodifiable Set view of the property entries contained in this Provider. |
Object |
Returns the value to which the specified key is mapped, or 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. |
Provider.Service |
getService(String type, String algorithm) Get the service describing this Provider's implementation of the specified type of this algorithm or alias. |
Set |
Get an unmodifiable Set of all services supported by this Provider. |
double |
Returns the version number for this provider. |
Enumeration |
keys() Returns an enumeration of the keys in this hashtable. |
Set |
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. |
Object |
Sets the key property to have the specified
value .
|
void |
Copies all of the mappings from the specified Map to this provider. |
protected void |
Add a service. |
Object |
Removes the key property (and its corresponding
value ).
|
protected void |
Remove a service previously added using java.security.Provider.putService. |
String |
toString() Returns a string with the name and the version number of this provider. |
Collection |
values() Returns an unmodifiable Collection view of the property values contained in this provider. |
Methods inherited from class java.util.Properties |
---|
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames |
Methods inherited from class java.util.Hashtable |
---|
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values |
Methods inherited from class java.util.Dictionary |
---|
elements, get, isEmpty, keys, put, remove, size |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Provider(String name, double version, String info)
name
- the provider name.version
- the provider version number.info
- a description of the provider and its services.Method Detail |
---|
public synchronized void clear()
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.
clear
in class Hashtable
public Enumeration elements()
elements
in class Hashtable
public synchronized Set entrySet()
entrySet
in class Hashtable
public Object get(Object key)
get
in class Hashtable
key
public String getInfo()
public String getName()
public String getProperty(String key)
getProperty
in class Properties
key
public synchronized Provider.Service getService(String type, String algorithm)
type
- the type of {@link Service service} requested
(for example, MessageDigest
)algorithm
- the case insensitive algorithm name (or alternate
alias) of the service requested (for example, SHA-1
)public synchronized Set getServices()
public double getVersion()
public Enumeration keys()
keys
in class Hashtable
public Set keySet()
keySet
in class Hashtable
public synchronized 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 synchronized Object put(Object key, Object value)
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.
put
in class Hashtable
key
- the property key.value
- the property value.key
), or null if it did not have one.public synchronized void putAll(Map t)
putAll
in class Hashtable
t
protected synchronized void putService(Provider.Service s)
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 addpublic synchronized Object remove(Object key)
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.
remove
in class Hashtable
key
- the key for the property to be removed.protected synchronized void removeService(Provider.Service s)
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 removedpublic String toString()
toString
in class Hashtable
public Collection values()
values
in class Hashtable
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |