java.security

Class Provider

Implemented Interfaces:
Cloneable, Map<K,V>, Serializable

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

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

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)
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, setProperty, store, storeToXML, storeToXML, void save

Methods inherited from class java.util.Hashtable<K,V>

V>> entrySet, clear, clone, contains, containsKey, containsValue, elements, equals, get, hashCode, isEmpty, keySet, keys, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.util.Dictionary<K,V>

elements, get, isEmpty, keys, put, remove, size

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

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<K,V>
Overrides:
clear in interface Hashtable<K,V>

get

public Object get(Object key)
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<K,V>
Overrides:
get in interface Hashtable<K,V>
Parameters:
key - the key for which to fetch an associated value
Returns:
what the key maps to, if present
Throws:
NullPointerException - if key is null
See Also:
put(Object, Object), Hashtable.containsKey(Object)

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

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

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<K,V>
Overrides:
remove in interface Hashtable<K,V>
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.
Overrides:
toString in interface Hashtable<K,V>
Returns:
A String representation of this object.

Provider.java -- Security provider information Copyright (C) 1998, 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.