Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public final class

SunPKCS11

extends AuthProvider

java.lang.Object
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<K, V>
		↳	java.util.Properties
			↳	java.security.Provider
				↳	java.security.AuthProvider
					↳	sun.security.pkcs11.SunPKCS11

Class Overview

PKCS#11 provider main class.

Summary

[Expand]

Inherited Fields

From class java.util.Properties

Public Constructors
	SunPKCS11()
	SunPKCS11(String configName)
	SunPKCS11(InputStream configStream)
	SunPKCS11(String configName, InputStream configStream) This constructor is deprecated. use new SunPKCS11(String) or new SunPKCS11(InputStream) instead

Public Methods
boolean	equals(Object obj) Compares the specified Object with this Map for equality, as per the definition in the Map interface.
int	hashCode() Returns the hash code value for this Map as per the definition in the Map interface.
void	login(Subject subject, CallbackHandler handler) Log in to this provider.
void	logout() Log out from this provider
void	setCallbackHandler(CallbackHandler handler) Set a `CallbackHandler` The provider uses this handler if one is not passed to the `login` method.

[Expand]

Inherited Methods

From class java.security.AuthProvider

From class java.security.Provider

synchronized 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.
synchronized Set<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.
synchronized Provider.Service	getService(String type, String algorithm) Get the service describing this Provider's implementation of the specified type of this algorithm or alias.
synchronized Set<Provider.Service>	getServices() Get an unmodifiable Set of all services supported by this Provider.
double	getVersion() Returns the version number for this provider.
Set<Object>	keySet() Returns an unmodifiable Set view of the property keys contained in this provider.
Enumeration<Object>	keys() Returns an enumeration of the keys in this hashtable.
synchronized void	load(InputStream inStream) Reads a property list (key and element pairs) from the input stream.
synchronized Object	put(Object key, Object value) Sets the `key` property to have the specified `value`.
synchronized void	putAll(Map<?, ?> t) Copies all of the mappings from the specified Map to this provider.
synchronized void	putService(Provider.Service s) Add a service.
synchronized Object	remove(Object key) Removes the `key` property (and its corresponding `value`).
synchronized 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.

From class java.util.Properties

String	getProperty(String key, String defaultValue) Searches for the property with the specified key in this property list.
String	getProperty(String key) Searches for the property with the specified key in this property list.
void	list(PrintStream out) Prints this property list out to the specified output stream.
void	list(PrintWriter out) Prints this property list out to the specified output stream.
synchronized void	load(InputStream inStream) Reads a property list (key and element pairs) from the input byte stream.
synchronized void	load(Reader reader) Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format.
synchronized void	loadFromXML(InputStream in) Loads all of the properties represented by the XML document on the specified input stream into this properties table.
Enumeration<?>	propertyNames() Returns an enumeration of all the keys in this property list, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.
synchronized void	save(OutputStream out, String comments) This method is deprecated. This method does not throw an IOException if an I/O error occurs while saving the property list. The preferred way to save a properties list is via the `store(OutputStream out, String comments)` method or the `storeToXML(OutputStream os, String comment)` method.
synchronized Object	setProperty(String key, String value) Calls the `Hashtable` method `put`.
void	store(OutputStream out, String comments) Writes this property list (key and element pairs) in this `Properties` table to the output stream in a format suitable for loading into a `Properties` table using the `load(InputStream)` method.
void	store(Writer writer, String comments) Writes this property list (key and element pairs) in this `Properties` table to the output character stream in a format suitable for using the `load(Reader)` method.
synchronized void	storeToXML(OutputStream os, String comment, String encoding) Emits an XML document representing all of the properties contained in this table, using the specified encoding.
synchronized void	storeToXML(OutputStream os, String comment) Emits an XML document representing all of the properties contained in this table.
Set<String>	stringPropertyNames() Returns a set of keys in this property list where the key and its corresponding value are strings, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.

From class java.util.Hashtable

synchronized void	clear() Clears this hashtable so that it contains no keys.
synchronized Object	clone() Creates a shallow copy of this hashtable.
synchronized boolean	contains(Object value) Tests if some key maps into the specified value in this hashtable.
synchronized boolean	containsKey(Object key) Tests if the specified object is a key in this hashtable.
boolean	containsValue(Object value) Returns true if this hashtable maps one or more keys to this value.
synchronized Enumeration<V>	elements() Returns an enumeration of the values in this hashtable.
Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
synchronized boolean	equals(Object o) Compares the specified Object with this Map for equality, as per the definition in the Map interface.
synchronized V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
synchronized int	hashCode() Returns the hash code value for this Map as per the definition in the Map interface.
synchronized boolean	isEmpty() Tests if this hashtable maps no keys to values.
Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
synchronized Enumeration<K>	keys() Returns an enumeration of the keys in this hashtable.
synchronized V	put(K key, V value) Maps the specified `key` to the specified `value` in this hashtable.
synchronized void	putAll(Map<? extends K, ? extends V> t) Copies all of the mappings from the specified map to this hashtable.
void	rehash() Increases the capacity of and internally reorganizes this hashtable, in order to accommodate and access its entries more efficiently.
synchronized V	remove(Object key) Removes the key (and its corresponding value) from this hashtable.
synchronized int	size() Returns the number of keys in this hashtable.
synchronized String	toString() Returns a string representation of this `Hashtable` object in the form of a set of entries, enclosed in braces and separated by the ASCII characters "`,` " (comma and space).
Collection<V>	values() Returns a `Collection` view of the values contained in this map.

From class java.util.Dictionary

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.util.Map

abstract void	clear() Removes all of the mappings from this map (optional operation).
abstract boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key.
abstract boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
abstract boolean	equals(Object o) Compares the specified object with this map for equality.
abstract V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
abstract int	hashCode() Returns the hash code value for this map.
abstract boolean	isEmpty() Returns `true` if this map contains no key-value mappings.
abstract Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
abstract V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
abstract void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
abstract V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).
abstract int	size() Returns the number of key-value mappings in this map.
abstract Collection<V>	values() Returns a `Collection` view of the values contained in this map.

Public Constructors

public SunPKCS11 ()

public SunPKCS11 (String configName)

public SunPKCS11 (InputStream configStream)

public SunPKCS11 (String configName, InputStream configStream)

This constructor is deprecated.
use new SunPKCS11(String) or new SunPKCS11(InputStream) instead

Public Methods

public boolean equals (Object obj)

Compares the specified Object with this Map for equality, as per the definition in the Map interface.

Parameters

obj	object to be compared for equality with this hashtable

Returns

true if the specified Object is equal to this Map

public int hashCode ()

Returns the hash code value for this Map as per the definition in the Map interface.

Returns

a hash code value for this object.

public void login (Subject subject, CallbackHandler handler)

Log in to this provider.

If the token expects a PIN to be supplied by the caller, the handler implementation must support a PasswordCallback.

To determine if the token supports a protected authentication path, the CK_TOKEN_INFO flag, CKF_PROTECTED_AUTHENTICATION_PATH, is consulted.

Parameters

subject	this parameter is ignored
handler	the `CallbackHandler` used by this provider to communicate with the caller

Throws

LoginException	if the login operation fails
SecurityException	if the does not pass a security check for `SecurityPermission("authProvider.name")`, where name is the value returned by this provider's `getName` method

public void logout ()

Log out from this provider

Throws

LoginException	if the logout operation fails
SecurityException	if the does not pass a security check for `SecurityPermission("authProvider.name")`, where name is the value returned by this provider's `getName` method

public void setCallbackHandler (CallbackHandler handler)

Set a CallbackHandler

The provider uses this handler if one is not passed to the login method. The provider also uses this handler if it invokes login on behalf of callers. In either case if a handler is not set via this method, the provider queries the auth.login.defaultCallbackHandler security property for the fully qualified class name of a default handler implementation. If the security property is not set, the provider is assumed to have alternative means for obtaining authentication information.

Parameters

handler	a `CallbackHandler` for obtaining authentication information, which may be `null`

Throws

SecurityException	if the caller does not pass a security check for `SecurityPermission("authProvider.name")`, where name is the value returned by this provider's `getName` method

Classes

Enums

SunPKCS11

Class Overview

Summary

Public Constructors

public SunPKCS11 ()

public SunPKCS11 (String configName)

public SunPKCS11 (InputStream configStream)

public SunPKCS11 (String configName, InputStream configStream)

Public Methods

public boolean equals (Object obj)

Parameters

Returns

public int hashCode ()

Returns

public void login (Subject subject, CallbackHandler handler)

Parameters

Throws

public void logout ()

Throws

public void setCallbackHandler (CallbackHandler handler)

Parameters

Throws