/**
* Stores the keystore in the specified output stream and it uses the specified key it keep it
* secure.
*
* @param stream the output stream to save the keystore to
* @param password the password to protect the keystore integrity with
* @throws IOException if an I/O error occurs.
* @throws NoSuchAlgorithmException the data integrity algorithm used cannot be found.
* @throws CertificateException if any certificates could not be stored in the output stream.
*/
public final void store(OutputStream stream, char[] password)
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException {
keyStoreSpi.engineStore(stream, password);
}
/**
* Loads the keystore from the specified input stream and it uses the specified password to check
* for integrity if supplied.
*
* @param stream the input stream to load the keystore from
* @param password the password to check the keystore integrity with
* @throws IOException if an I/O error occurs.
* @throws NoSuchAlgorithmException the data integrity algorithm used cannot be found.
* @throws CertificateException if any certificates could not be stored in the output stream.
*/
public final void load(InputStream stream, char[] password)
throws IOException, NoSuchAlgorithmException, CertificateException {
keyStoreSpi.engineLoad(stream, password);
}
/**
* Determines if the keystore contains a certificate entry for the specified alias.
*
* @param alias the alias name
* @return true if it is a certificate entry, false otherwise
*/
public final boolean isCertificateEntry(String alias) throws KeyStoreException {
return keyStoreSpi.engineIsCertificateEntry(alias);
}
/**
* Determines if the keystore contains the specified certificate entry and returns the alias.
*
* <p>It checks every entry and for a key entry checks only the first certificate in the chain.
*
* @param cert Certificate to look for
* @return alias of first matching certificate, null if it does not exist.
*/
public final String getCertificateAlias(java.security.cert.Certificate cert)
throws KeyStoreException {
return keyStoreSpi.engineGetCertificateAlias(cert);
}
/**
* Determines if the keystore contains the specified alias.
*
* @param alias the alias name
* @return true if it contains the alias, false otherwise
*/
public final boolean containsAlias(String alias) throws KeyStoreException {
return keyStoreSpi.engineContainsAlias(alias);
}
/**
* Returns the number of entries in the keystore.
*
* @returns the number of keystore entries.
*/
public final int size() throws KeyStoreException {
return keyStoreSpi.engineSize();
}
/**
* Deletes the entry for the specified entry.
*
* @param alias the alias name
* @throws KeyStoreException if it fails
*/
public final void deleteEntry(String alias) throws KeyStoreException {
keyStoreSpi.engineDeleteEntry(alias);
}
/**
* Generates a list of all the aliases in the keystore.
*
* @return an Enumeration of the aliases
*/
public final Enumeration<String> aliases() throws KeyStoreException {
return keyStoreSpi.engineAliases();
}
/**
* Assign the certificate to the alias in the keystore. It will overwrite an existing entry.
*
* @param alias the alias name
* @param cert the certificate to add
* @throws KeyStoreException if it fails
*/
public final void setCertificateEntry(String alias, java.security.cert.Certificate cert)
throws KeyStoreException {
keyStoreSpi.engineSetCertificateEntry(alias, cert);
}
/**
* Assign the key to the alias in the keystore. It will overwrite an existing entry and if the key
* is a PrivateKey, also add the certificate chain representing the corresponding public key.
*
* @param alias the alias name
* @param key the key to add
* @param chain the certificate chain for the corresponding public key
* @throws KeyStoreException if it fails
*/
public final void setKeyEntry(String alias, byte[] key, java.security.cert.Certificate[] chain)
throws KeyStoreException {
keyStoreSpi.engineSetKeyEntry(alias, key, chain);
}
/**
* Gets entry creation date for the specified alias.
*
* @param alias the alias name
* @returns the entry creation date or null
*/
public final Date getCreationDate(String alias) throws KeyStoreException {
return keyStoreSpi.engineGetCreationDate(alias);
}
/**
* Gets a Certificate for the specified alias.
*
* <p>If there is a trusted certificate entry then that is returned. it there is a key entry with
* a certificate chain then the first certificate is return or else null.
*
* @param alias the alias name
* @return a Certificate or null if the alias does not exist or there is no certificate for the
* alias
*/
public final java.security.cert.Certificate getCertificate(String alias)
throws KeyStoreException {
return keyStoreSpi.engineGetCertificate(alias);
}
/**
* Returns the key associated with given alias using the supplied password.
*
* @param alias an alias for the key to get
* @param password password to access key with
* @return the requested key, or null otherwise
* @throws NoSuchAlgorithmException if there is no algorithm for recovering the key
* @throws UnrecoverableKeyException key cannot be reocovered (wrong password).
*/
public final Key getKey(String alias, char[] password)
throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException {
return keyStoreSpi.engineGetKey(alias, password);
}
