|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.Dictionary<K,V>
java.util.Hashtable<Object,Object>
java.util.Properties
java.security.Provider
public abstract class Provider
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 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 |
Provider.Service
The description of a security service. |
| Field Summary |
|---|
| Fields inherited from class java.util.Properties |
|---|
defaults |
| Constructor Summary | |
|---|---|
protected |
Provider(String name,
double version,
String info)
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<Object> |
elements()
Returns an enumeration of the values in this hashtable. |
Set<Map.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. |
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<Provider.Service> |
getServices()
Get an unmodifiable Set of all services supported by this Provider. |
double |
getVersion()
Returns the version number for this provider. |
Enumeration<Object> |
keys()
Returns an enumeration of the keys in this hashtable. |
Set<Object> |
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 |
put(Object key,
Object value)
Sets the key property to have the specified
value. |
void |
putAll(Map<?,?> t)
Copies all of the mappings from the specified Map to this provider. |
protected void |
putService(Provider.Service s)
Add a service. |
Object |
remove(Object key)
Removes the key property (and its corresponding
value). |
protected void |
removeService(Provider.Service s)
Remove a service previously added using putService(). |
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. |
| Methods inherited from class java.util.Properties |
|---|
getProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames |
| Methods inherited from class java.util.Hashtable |
|---|
clone, contains, containsKey, containsValue, equals, hashCode, isEmpty, rehash, size |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, 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 String getName()
public double getVersion()
public String getInfo()
public String toString()
toString in class Hashtable<Object,Object>public 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 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 provider
public void load(InputStream inStream)
throws IOException
load in class PropertiesinStream - the input stream.
IOException - if an error occurred when reading from the
input stream.Properties.load(java.io.Reader)public void putAll(Map<?,?> t)
putAll in interface Map<Object,Object>putAll in class Hashtable<Object,Object>t - mappings to be stored in this mappublic Set<Map.Entry<Object,Object>> entrySet()
entrySet in interface Map<Object,Object>entrySet in class Hashtable<Object,Object>Map.Entrypublic Set<Object> keySet()
keySet in interface Map<Object,Object>keySet in class Hashtable<Object,Object>public Collection<Object> values()
values in interface Map<Object,Object>values in class Hashtable<Object,Object>
public 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 interface Map<Object,Object>put in class Hashtable<Object,Object>key - the property key.value - the property value.
key), or null if it did not have one.
SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method
denies access to set property values.Object.equals(Object),
Hashtable.get(Object)public 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 interface Map<Object,Object>remove in class Hashtable<Object,Object>key - the key for the property to be removed.
SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method
denies access to remove this provider's properties.public Object get(Object key)
Hashtablenull 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.)
get in interface Map<Object,Object>get in class Hashtable<Object,Object>key - the key whose associated value is to be returned
null if this map contains no mapping for the keyHashtable.put(Object, Object)public Enumeration<Object> keys()
Hashtable
keys in class Hashtable<Object,Object>Enumeration,
Hashtable.elements(),
Hashtable.keySet(),
Mappublic Enumeration<Object> elements()
Hashtable
elements in class Hashtable<Object,Object>Enumeration,
Hashtable.keys(),
Hashtable.values(),
Mappublic String getProperty(String key)
Propertiesnull if the property is not found.
getProperty in class Propertieskey - the property key.
Properties.setProperty(java.lang.String, java.lang.String),
Properties.defaults
public Provider.Service getService(String type,
String algorithm)
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)
NullPointerException - if type or algorithm is nullpublic Set<Provider.Service> getServices()
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 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.
s - the Service to add
SecurityException - if a security manager exists and its SecurityManager.checkSecurityAccess(java.lang.String) method denies
access to set property values.
NullPointerException - if s is nullprotected 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
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 removed
SecurityException - 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
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.