KeyStoreSpi JDK 1.6)

Hide/Show inherited methods

publicabstract Enumeration<String> engineAliases ()

Lists all the alias names of this keystore.

publicabstract boolean engineContainsAlias (String alias)

Checks if the given alias exists in this keystore.

publicabstract void engineDeleteEntry (String alias) throws KeyStoreException

Deletes the entry identified by the given alias from this keystore.

public boolean engineEntryInstanceOf (String alias, Class<Entry> entryClass)

Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass.

Determines if the keystore Entry for the specified
alias is an instance or subclass of the specified
entryClass.
Returns: true if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass, false otherwise
Parameters:
- alias - the alias name
- entryClass - the entry class
Since: 1.5

publicabstract Certificate engineGetCertificate (String alias)

Returns the certificate associated with the given alias.

publicabstract String engineGetCertificateAlias (Certificate cert)

Returns the (alias) name of the first keystore entry whose certificate matches the given certificate.

publicabstract Certificate engineGetCertificateChain (String alias)

Returns the certificate chain associated with the given alias.

Returns the certificate chain associated with the given alias.
The certificate chain must have been associated with the alias
by a call to setKeyEntry,
or by a call to setEntry with a
PrivateKeyEntry.
Returns: the certificate chain (ordered with the user's certificate first and the root certificate authority last), or null if the given alias does not exist or does not contain a certificate chain
Parameters:
- alias - the alias name

publicabstract Date engineGetCreationDate (String alias)

Returns the creation date of the entry identified by the given alias.

public Entry engineGetEntry (String alias, ProtectionParameter protParam) throws KeyStoreException NoSuchAlgorithmException UnrecoverableEntryException

Gets a KeyStore.Entry for the specified alias with the specified protection parameter.

Gets a KeyStore.Entry for the specified alias
with the specified protection parameter.
Returns: the KeyStore.Entry for the specified alias, or null if there is no such entry
Parameters:
- alias - get the KeyStore.Entry for this alias
- protParam - the ProtectionParameter used to protect the Entry, which may be null
Throws:
- KeyStoreException - if the operation failed
- NoSuchAlgorithmException - if the algorithm for recovering the entry cannot be found
- UnrecoverableEntryException - if the specified protParam were insufficient or invalid
- UnrecoverableKeyException - if the entry is a PrivateKeyEntry or SecretKeyEntry and the specified protParam does not contain the information needed to recover the key (e.g. wrong password)
Since: 1.5

publicabstract Key engineGetKey (String alias, char[] password) throws NoSuchAlgorithmException UnrecoverableKeyException

Returns the key associated with the given alias, using the given password to recover it.

Returns the key associated with the given alias, using the given
password to recover it. The key must have been associated with
the alias by a call to setKeyEntry,
or by a call to setEntry with a
PrivateKeyEntry or SecretKeyEntry.
Returns: the requested key, or null if the given alias does not exist or does not identify a key-related entry.
Parameters:
- alias - the alias name
- password - the password for recovering the key
Throws:
- NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found
- UnrecoverableKeyException - if the key cannot be recovered (e.g., the given password is wrong).

publicabstract boolean engineIsCertificateEntry (String alias)

Returns true if the entry identified by the given alias was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry.

Returns true if the entry identified by the given alias
was created by a call to setCertificateEntry,
or created by a call to setEntry with a
TrustedCertificateEntry.
Returns: true if the entry identified by the given alias contains a trusted certificate, false otherwise.
Parameters:
- alias - the alias for the keystore entry to be checked

publicabstract boolean engineIsKeyEntry (String alias)

Returns true if the entry identified by the given alias was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry or a SecretKeyEntry.

Returns true if the entry identified by the given alias
was created by a call to setKeyEntry,
or created by a call to setEntry with a
PrivateKeyEntry or a SecretKeyEntry.
Returns: true if the entry identified by the given alias is a key-related, false otherwise.
Parameters:
- alias - the alias for the keystore entry to be checked

publicabstract void engineLoad (InputStream stream, char[] password) throws IOException NoSuchAlgorithmException CertificateException

Loads the keystore from the given input stream.

public void engineLoad (LoadStoreParameter param) throws IOException NoSuchAlgorithmException CertificateException

Loads the keystore using the given KeyStore.LoadStoreParameter.

Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.
Parameters:
- param - the KeyStore.LoadStoreParameter that specifies how to load the keystore, which may be null
Throws:
- IllegalArgumentException - if the given KeyStore.LoadStoreParameter input is not recognized
- IOException - if there is an I/O or format problem with the keystore data. If the error is due to an incorrect ProtectionParameter (e.g. wrong password) the {@link Throwable#getCause cause} of the IOException should be an UnrecoverableKeyException
- NoSuchAlgorithmException - if the algorithm used to check the integrity of the keystore cannot be found
- CertificateException - if any of the certificates in the keystore could not be loaded
Since: 1.5

publicabstract void engineSetCertificateEntry (String alias, Certificate cert) throws KeyStoreException

Assigns the given certificate to the given alias.

public void engineSetEntry (String alias, Entry entry, ProtectionParameter protParam) throws KeyStoreException

Saves a KeyStore.Entry under the specified alias.

Saves a KeyStore.Entry under the specified alias. The specified protection parameter is used to protect the Entry.

If an entry already exists for the specified alias, it is overridden.
Parameters:
- alias - save the KeyStore.Entry under this alias
- entry - the Entry to save
- protParam - the ProtectionParameter used to protect the Entry, which may be null
Throws:
- KeyStoreException - if this operation fails
Since: 1.5

publicabstract void engineSetKeyEntry (String alias, byte[] key, Certificate chain) throws KeyStoreException

Assigns the given key (that has already been protected) to the given alias.

publicabstract void engineSetKeyEntry (String alias, Key key, char[] password, Certificate chain) throws KeyStoreException

Assigns the given key to the given alias, protecting it with the given password.

publicabstract int engineSize ()

Retrieves the number of entries in this keystore.

public void engineStore (LoadStoreParameter param) throws IOException NoSuchAlgorithmException CertificateException

Stores this keystore using the given KeyStore.LoadStoreParmeter.

Stores this keystore using the given
KeyStore.LoadStoreParmeter.
Parameters:
- param - the KeyStore.LoadStoreParmeter that specifies how to store the keystore, which may be null
Throws:
- IllegalArgumentException - if the given KeyStore.LoadStoreParmeter input is not recognized
- IOException - if there was an I/O problem with data
- NoSuchAlgorithmException - if the appropriate data integrity algorithm could not be found
- CertificateException - if any of the certificates included in the keystore data could not be stored
Since: 1.5

publicabstract void engineStore (OutputStream stream, char[] password) throws IOException NoSuchAlgorithmException CertificateException

Stores this keystore to the given output stream, and protects its integrity with the given password.