gnu.crypto.keyring

Class BaseKeyring

Implemented Interfaces:
IKeyring
Known Direct Subclasses:
GnuPrivateKeyring, GnuPublicKeyring

public abstract class BaseKeyring
extends java.lang.Object
implements IKeyring

Field Summary

protected PasswordAuthenticatedEntry
keyring
The top-level keyring data.
protected CompressedEntry
keyring2

Fields inherited from interface gnu.crypto.keyring.IKeyring

KEYRING_DATA_IN, KEYRING_DATA_OUT, KEYRING_PASSWORD

Constructor Summary

BaseKeyring()

Method Summary

void
add(Entry entry)
Adds a designated Entry to this keyring.

What happens if there is already an entry with the same alias?

Enumeration
aliases()
Returns an Enumeration of all aliases (instances of String) in this keyring.
boolean
containsAlias(String alias)
Tests whether or not this keyring contains the given alias.
protected String
fixAlias(String alias)
List
get(String alias)
Returns a List of entries (instances of Entry) for the given alias, or null if there no such entry exists.
protected void
load(InputStream in, char[] password)
void
load(Map attributes)
Loads a keyring into memory.

What happens to the current contents of this keyring?

void
remove(String alias)
Removes an entry with the designated alias from this keyring.
void
reset()
Resets this keyring, clearing all sensitive data.
int
size()
Returns the number of entries in this keyring.
void
store(Map attributes)
Stores the contents of this keyring to persistent storage as specified by the designated attributes.
protected void
store(OutputStream out, char[] password)

Field Details

keyring

protected PasswordAuthenticatedEntry keyring
The top-level keyring data.


keyring2

protected CompressedEntry keyring2

Constructor Details

BaseKeyring

public BaseKeyring()

Method Details

add

public void add(Entry entry)
Adds a designated Entry to this keyring.

What happens if there is already an entry with the same alias?

Specified by:
add in interface IKeyring

Parameters:
entry - The entry to put in this keyring.


aliases

public Enumeration aliases()
Returns an Enumeration of all aliases (instances of String) in this keyring.
Specified by:
aliases in interface IKeyring

Returns:
The enumeration of Strings each representing an alias found in this keyring.


containsAlias

public boolean containsAlias(String alias)
Tests whether or not this keyring contains the given alias.
Specified by:
containsAlias in interface IKeyring

Parameters:
alias - The alias to check.

Returns:
true if this keyring contains the alias.


fixAlias

protected String fixAlias(String alias)


get

public List get(String alias)
Returns a List of entries (instances of Entry) for the given alias, or null if there no such entry exists.
Specified by:
get in interface IKeyring

Parameters:
alias - The alias of the entry(ies) to return.

Returns:
A list of all entries (instances of Entry that have the given alias, or null if no one Entry can be found with the designated alias.


load

protected void load(InputStream in,
                    char[] password)
            throws IOException


load

public void load(Map attributes)
            throws IOException
Loads a keyring into memory.

What happens to the current contents of this keyring? are the new ones merged with the current ones or do they simply replace them?

Specified by:
load in interface IKeyring

Parameters:
attributes - The attributes that designate the source where the store is to be loaded from. What happens


remove

public void remove(String alias)
Removes an entry with the designated alias from this keyring. Does nothing if there was no such entry.

What happens if there are more than one?

Specified by:
remove in interface IKeyring

Parameters:
alias - The alias of the entry to remove.


reset

public void reset()
Resets this keyring, clearing all sensitive data. This method always suceeds.
Specified by:
reset in interface IKeyring


size

public int size()
Returns the number of entries in this keyring.
Specified by:
size in interface IKeyring

Returns:
The number of current entries in this keyring.


store

public void store(Map attributes)
            throws IOException
Stores the contents of this keyring to persistent storage as specified by the designated attributes.
Specified by:
store in interface IKeyring

Parameters:
attributes - the attributes that define where the contents of this keyring will be stored.


store

protected void store(OutputStream out,
                     char[] password)
            throws IOException


Copyright © 2001, 2002, 2003 Free Software Foundation, Inc. All Rights Reserved.