Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.javax.crypto.keyring

Interface IPrivateKeyring

All Superinterfaces:
IKeyring
Known Implementing Classes:
GnuPrivateKeyring
public interface IPrivateKeyring
extends IKeyring
An interface to private, or "personal", keyrings, which contain private credentials. The contract is that each such entry is known by a unique alias.

What about public keys? and certificate-path?

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

KEYRING_DATA_IN, KEYRING_DATA_OUT, KEYRING_PASSWORD

Method Summary

boolean
containsCertPath(String alias)
Checks if this keyring contains a certificate path with the given alias.
boolean
containsPrivateKey(String alias)
Tests if this keyring contains a private key entry with the given alias.
boolean
containsPublicKey(String alias)
Checks if this keyring contains a public key with the given alias.
Certificate[]
getCertPath(String alias)
Returns the certificate path with the given alias, or null if there is no such entry.
Key
getPrivateKey(String alias, char[] password)
Returns the private key with the given alias.
PublicKey
getPublicKey(String alias)
Returns the public key with the given alias, or null if there is no such entry.
void
putCertPath(String alias, Certificate[] path)
Sets a certificate path entry.
void
putPrivateKey(String alias, Key key, char[] password)
Adds a private key to this keyring.
void
putPublicKey(String alias, PublicKey key)
Sets a public key entry.

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

add, aliases, containsAlias, get, load, remove, reset, size, store

Method Details

containsCertPath

public boolean containsCertPath(String alias)
Checks if this keyring contains a certificate path with the given alias.
Parameters:
alias - The alias to check.
Returns:
true if this keyring contains a certificate path with the given alias; false otherwise.

containsPrivateKey

public boolean containsPrivateKey(String alias)
Tests if this keyring contains a private key entry with the given alias.
Parameters:
alias - The alias to check.
Returns:
true if this keyring contains a private key with the given alias; false otherwise.

containsPublicKey

public boolean containsPublicKey(String alias)
Checks if this keyring contains a public key with the given alias.
Parameters:
alias - The alias to test.
Returns:
true if this keyring contains a public key entry with the given alias; false otherwise.

getCertPath

public Certificate[] getCertPath(String alias)
Returns the certificate path with the given alias, or null if there is no such entry.
Parameters:
alias - The alias of the certificate path to find.
Returns:
The certificate path for the designated alias; or null if none were found.

getPrivateKey

public Key getPrivateKey(String alias,
                         char[] password)
            throws UnrecoverableKeyException
Returns the private key with the given alias.
Parameters:
alias - The alias of the private key to find.
password - The password of the private key.
Returns:
The private, or secret, key if one is found; null if none were found.
Throws:
UnrecoverableKeyException - If the private key could not be recovered, possibly due to a bad password.

getPublicKey

public PublicKey getPublicKey(String alias)
Returns the public key with the given alias, or null if there is no such entry.
Parameters:
alias - The alias of the public key to find.
Returns:
The public key; or null if none were found.

putCertPath

public void putCertPath(String alias,
                        Certificate[] path)
Sets a certificate path entry.
Parameters:
alias - The alias for this certificate path.
path - The certificate path.

putPrivateKey

public void putPrivateKey(String alias,
                          Key key,
                          char[] password)
Adds a private key to this keyring.
Parameters:
alias - The alias of the private key.
key - The private key.
password - The password used to protect this private key.

putPublicKey

public void putPublicKey(String alias,
                         PublicKey key)
Sets a public key entry.
Parameters:
alias - The alias for this public key.
key - The public key.
IPrivateKeyring.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.

Overview Package Class Use Source Tree Index Deprecated About