Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.javax.crypto.keyring
Interface IKeyring  view IKeyring download IKeyring.java

All Known Subinterfaces:
IPrivateKeyring, IPublicKeyring
All Known Implementing Classes:
BaseKeyring, GnuPrivateKeyring, GnuPublicKeyring

public interface IKeyring

The top-level interface to a keyring: a file that is used to store and protect public and private cryptographic keys.

A keyring is modelled as a mapping of one alias to one or more entries (optionally of different types).

See also the sub-interfaces IPublicKeyring and IPrivateKeyring for special types of keyrings --the difference being in the type of entries they contain.


Field Summary
static java.lang.String KEYRING_DATA_IN
          Property name for the source of data to load the keyring from.
static java.lang.String KEYRING_DATA_OUT
          Property name for the data sink to store the keyring to.
static java.lang.String KEYRING_PASSWORD
          Property name for the keyring's top-level password, used to authenticate and/or transform the store itself.
 
Method Summary
 void add(Entry entry)
          Adds a designated Entry to this keyring.
 java.util.Enumeration aliases()
          Returns an java.util.Enumeration of all aliases (instances of java.lang.String) in this keyring.
 boolean containsAlias(java.lang.String alias)
          Tests whether or not this keyring contains the given alias.
 java.util.List get(java.lang.String alias)
          Returns a java.util.List of entries (instances of Entry) for the given alias, or null if there no such entry exists.
 void load(java.util.Map attributes)
          Loads a keyring into memory.
 void remove(java.lang.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(java.util.Map attributes)
          Stores the contents of this keyring to persistent storage as specified by the designated attributes.
 

Field Detail

KEYRING_DATA_IN

public static final java.lang.String KEYRING_DATA_IN

Property name for the source of data to load the keyring from. The value mapped must be a java.io.InputStream.

See Also:
Constant Field Values

KEYRING_DATA_OUT

public static final java.lang.String KEYRING_DATA_OUT

Property name for the data sink to store the keyring to. The value mapped must be a java.io.OutputStream.

See Also:
Constant Field Values

KEYRING_PASSWORD

public static final java.lang.String KEYRING_PASSWORD

Property name for the keyring's top-level password, used to authenticate and/or transform the store itself. The mapped value must be a char array.

See Also:
Constant Field Values
Method Detail

load

public void load(java.util.Map attributes)
          throws java.io.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?


store

public void store(java.util.Map attributes)
           throws java.io.IOException

Stores the contents of this keyring to persistent storage as specified by the designated attributes.


reset

public void reset()

Resets this keyring, clearing all sensitive data. This method always suceeds.


size

public int size()

Returns the number of entries in this keyring.


aliases

public java.util.Enumeration aliases()

Returns an java.util.Enumeration of all aliases (instances of java.lang.String) in this keyring.


containsAlias

public boolean containsAlias(java.lang.String alias)
Tests whether or not this keyring contains the given alias.


get

public java.util.List get(java.lang.String alias)

Returns a java.util.List of entries (instances of Entry) for the given alias, or null if there no such entry exists.


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?


remove

public void remove(java.lang.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?