java.security

Class Provider

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 {@link java.security.Security} class for the default security providers installed by this class library.

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

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

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 {@link SecurityManager} object in the underlying VM, its {@link 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 {@link SecurityManager#checkPermission(Permission)} for a SecurityPermission("clearProviderProperties." + name).

get

public Object get(Object key)

getInfo

public String getInfo()

This method returns a textual description of the Provider.

Returns: A description of the Provider.

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.

put

public Object put(Object key, Object value)

Maps a key property to a designated value.

If there is an installed {@link SecurityManager} object in the underlying VM, its {@link 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 {@link SecurityManager#checkPermission(Permission)} for a SecurityPermission("putProviderProperty." + name).

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 {@link SecurityManager#checkSecurityAccess(String)} method disallows adding properties at run-time.

Since: Classpath 0.4+cvs, JDK 1.2

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 {@link SecurityManager} object in the underlying VM, its {@link 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 {@link SecurityManager#checkPermission(Permission)} for a SecurityPermission("removeProviderProperty." + name).

Parameters: key The key to remove

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

toString

public String toString()

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

Returns: A String representation of this object.