gnu.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?

$Revision: 1.4 $

Fields inherited from interface gnu.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.crypto.keyring.IKeyring
`add`, `aliases`, `containsAlias`, `get`, `load`, `remove`, `reset`, `size`, `store`

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.

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.

Overview Package Class Use Tree Index Deprecated About	For the latest news and information visit The GNU Crypto project
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr