java.security

Class Provider

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

java.security.Provider

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public abstract class Provider
extends Properties
implements Serializable

This class represents a Java security architecture service provider. The services provided by a such a provider can range from security algorithms to key generation.

Providers are installed by name and version number. See the static initializer of the Security class for the default security providers installed by this class library.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Provider(String name, double version, String info) This method initializes a new instance of Provider to have the specified name, version, and description information.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() This method clears the entire property collection such that it no longer contains the properties used to look up the services provided by this Provider.
Object	get(Object key) Return the value in this Hashtable associated with the supplied key, or null if the key maps to nothing.
String	getInfo() This method returns a textual description of the Provider.
String	getName() This method returns the name assigned to this Provider.
double	getVersion() This method retunrs the version number of this Provider.
Object	put(Object key, Object value) Maps a key property to a designated value.
Object	remove(Object key) This method removes the specified key entry (and its associated value) from the property mapping collection.
String	toString() This method returns a String representation of this object.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, storeToXML, storeToXML

Methods inherited from class java.util.Hashtable

clone, contains, containsKey, containsValue, elements, entrySet, equals, hashCode, isEmpty, keys, keySet, putAll, rehash, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Provider

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

This method initializes a new instance of Provider to have the specified name, version, and description information.

Parameters:

name - The name to assign to this Provider.

version - The version number for this Provider.

info - A textual description of this provider.

Method Detail

getName

public String getName()

This method returns the name assigned to this Provider.

Returns:

The Provider's name.

getVersion

public double getVersion()

This method retunrs the version number of this Provider.

Returns:

The Provider's version number.

getInfo

public String getInfo()

This method returns a textual description of the Provider.

Returns:

A description of the Provider.

put

public Object put(Object key,
         Object value)

Maps a key property to a designated value.

If there is an installed SecurityManager object in the underlying VM, its SecurityManager.checkSecurityAccess(String) method is called with the string "putProviderProperty." + name, where name is this provider's name. For the default implementation this translates into a SecurityManager.checkPermission(Permission) for a SecurityPermission("putProviderProperty." + name).

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

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 is installed and its SecurityManager.checkSecurityAccess(String) method disallows adding properties at run-time.

Since:

Classpath 0.4+cvs, JDK 1.2

See Also:

Object.equals(Object), Hashtable.get(Object)

get

public Object get(Object key)

Description copied from class: Hashtable

Return the value in this Hashtable associated with the supplied key, or null if the key maps to nothing.

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class Hashtable<Object,Object>

Parameters:

key - the key for which to fetch an associated value

Returns:

what the key maps to, if present

See Also:

Hashtable.put(Object, Object), Hashtable.containsKey(Object)

remove

public Object remove(Object key)

This method removes the specified key entry (and its associated value) from the property mapping collection.

If there is an installed SecurityManager object in the underlying VM, its SecurityManager.checkSecurityAccess(String) method is called with the string "removeProviderProperty." + name, where name is this provider's name. For the default implementation this translates into a SecurityManager.checkPermission(Permission) for a SecurityPermission("removeProviderProperty." + name).

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Hashtable<Object,Object>

Parameters:

key - The key to remove

Returns:

The previous value for this key, or null if no previous value.

clear

public void clear()

This method clears the entire property collection such that it no longer contains the properties used to look up the services provided by this Provider.

If there is an installed SecurityManager object in the underlying VM, its SecurityManager.checkSecurityAccess(String) method is called with the string "clearProviderProperties." + name, where name is this provider's name. For the default implementation this translates into a SecurityManager.checkPermission(Permission) for a SecurityPermission("clearProviderProperties." + name).

Specified by:

clear in interface Map<Object,Object>

Overrides:

clear in class Hashtable<Object,Object>

toString

public String toString()

This method returns a String representation of this object. This will include the Provider name and version number.

Overrides:

toString in class Hashtable<Object,Object>

Returns:

A String representation of this object.

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)