gnu.javax.crypto.keyring

Class BaseKeyring

Implemented Interfaces:
IKeyring
Known Direct Subclasses:
GnuPrivateKeyring, GnuPublicKeyring

public abstract class BaseKeyring
extends Object
implements IKeyring

Field Summary

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

Fields inherited from interface gnu.javax.crypto.keyring.IKeyring

KEYRING_DATA_IN, KEYRING_DATA_OUT, KEYRING_PASSWORD

Constructor Summary

BaseKeyring()
The basic constructor.

Method Summary

void
add(Entry entry)
Adds a designated Entry to this keyring.
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 abstract void
load(InputStream in, char[] password)
void
load(Map attributes)
Loads a keyring into memory.
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.
protected abstract void
store(OutputStream out, char[] password)
void
store(Map attributes)
Stores the contents of this keyring to persistent storage as specified by the designated attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

keyring

protected PasswordAuthenticatedEntry keyring
The top-level keyring data.

keyring2

protected CompressedEntry keyring2

Constructor Details

BaseKeyring

public BaseKeyring()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

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 abstract 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
Throws:
IllegalArgumentException - If the attributes are inappropriate.
IOException - If the keyring file cannot be read.
SecurityException - If the given password is incorrect, or if the top-level authentication or decryption fails.

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

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

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.
Throws:
IOException - if an exception occurs during the process.

BaseKeyring.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a 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 of the License, 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; if not, write to the Free Software Foundation, Inc., 51 Franklin St, 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.