org.netbeans.modules.keyring 1.6.1

org.netbeans.api.keyring
Class Keyring

java.lang.Object
  extended by org.netbeans.api.keyring.Keyring

public class Keyring
extends Object

Client class for working with stored keys (such as passwords).

The key identifier should be unique for the whole application, so qualify it with any prefixes as needed.

Avoid calling methods on this class from the event dispatch thread, as some provider implementations may need to block while displaying a dialog (e.g. prompting for a master password to access the keyring).


Method Summary
static void delete(String key)
          Deletes a key from the ring.
static char[] read(String key)
          Reads a key from the ring.
static void save(String key, char[] password, String description)
          Saves a key to the ring.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

read

public static char[] read(String key)
Reads a key from the ring.

Parameters:
key - the identifier of the key
Returns:
its value if found (you may null out its elements), else null if not present

save

public static void save(String key,
                        char[] password,
                        String description)
Saves a key to the ring. If it could not be saved, does nothing. If the key already existed, overwrites the password.

Parameters:
key - a key identifier
password - the password or other sensitive information associated with the key (its contents will be nulled out by end of call)
description - a user-visible description of the key (may be null)

delete

public static void delete(String key)
Deletes a key from the ring. If the key was not in the ring to begin with, does nothing.

Parameters:
key - a key identifier

org.netbeans.modules.keyring 1.6.1

Built on December 5 2011.  |  Portions Copyright 1997-2011 Sun Microsystems, Inc. All rights reserved.