java.lang.Object java.security.KeyStoreSpi
This class defines the Service Provider Interface ( SPI ) for the KeyStore class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a keystore for a particular keystore type.
Constructor Summary | |
---|---|
KeyStoreSpi
() |
Method Summary | |
---|---|
abstract Enumeration |
engineAliases
() Lists all the alias names of this keystore. |
abstract boolean |
engineContainsAlias
(
String
alias) Checks if the given alias exists in this keystore. |
abstract void |
engineDeleteEntry
(
String
alias) Deletes the entry identified by the given alias from this keystore. |
boolean |
engineEntryInstanceOf
(
String
alias,
Class
Determines if the keystore Entry for the specified alias is an instance or subclass of the specified entryClass. |
abstract Certificate |
engineGetCertificate
(
String
alias) Returns the certificate associated with the given alias. |
abstract String |
engineGetCertificateAlias
(
Certificate
cert) Returns the (alias) name of the first keystore entry whose certificate matches the given certificate. |
abstract Certificate [] |
engineGetCertificateChain
(
String
alias) Returns the certificate chain associated with the given alias. |
abstract Date |
engineGetCreationDate
(
String
alias) Returns the creation date of the entry identified by the given alias. |
KeyStore.Entry |
engineGetEntry
(
String
alias,
KeyStore.ProtectionParameter
Gets a KeyStore.Entry for the specified alias with the specified protection parameter. |
abstract Key |
engineGetKey
(
String
alias, char[] password) Returns the key associated with the given alias, using the given password to recover it. |
abstract boolean |
engineIsCertificateEntry
(
String
Returns true if the entry identified by the given alias was created by |
abstract boolean |
engineIsKeyEntry
(
String
Returns true if the entry identified by the given alias was created by |
abstract void |
engineLoad
(
InputStream
stream, char[] password) Loads the keystore from the given input stream. |
void |
engineLoad
(
KeyStore.LoadStoreParameter
Loads the keystore using the given KeyStore.LoadStoreParameter. |
abstract void |
engineSetCertificateEntry
(
String
alias,
Certificate
cert) Assigns the given certificate to the given alias. |
void |
engineSetEntry
(
String
alias,
KeyStore.Entry
entry,
KeyStore.ProtectionParameter
Saves a KeyStore.Entry under the specified alias. |
abstract void |
engineSetKeyEntry
(
String
alias, byte[] key,
Certificate
[] chain) Assigns the given key (that has already been protected) to the given alias. |
abstract void |
engineSetKeyEntry
(
String
alias,
Key
key, char[] password,
Certificate
[] chain) Assigns the given key to the given alias, protecting it with the given password. |
abstract int |
engineSize
() Retrieves the number of entries in this keystore. |
void |
engineStore
(
KeyStore.LoadStoreParameter
Stores this keystore using the given KeyStore.LoadStoreParmeter. |
abstract void |
engineStore
(
OutputStream
stream, char[] password) Stores this keystore to the given output stream, and protects its integrity with the given password. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Constructor Detail |
---|
public KeyStoreSpi()
Method Detail |
---|
public abstract Key engineGetKey(String alias, char[] password) throws NoSuchAlgorithmException, UnrecoverableKeyException
public abstract Certificate[] engineGetCertificateChain(String alias)
public abstract Certificate engineGetCertificate(String alias)
If the given alias name identifies an entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the trusted certificate contained in that entry is returned.
If the given alias name identifies a
trusted certificate entry
, the certificate associated with that entry is returned. If the given alias name identifies a
key entry
, the first element of the certificate chain of that entry is returned, or null if that entry does not have a certificate chain.
If the given alias name identifies an entry created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the first element of the certificate chain in that entry (if a chain exists) is returned.
public abstract Date engineGetCreationDate(String alias)
public abstract void engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain) throws KeyStoreException
If the given key is of type java.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key.
If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).
public abstract void engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) throws KeyStoreException
If the protected key is of type java.security.PrivateKey, it must be accompanied by a certificate chain certifying the corresponding public key.
If the given alias already exists, the keystore information associated with it is overridden by the given key (and possibly certificate chain).
public abstract void engineSetCertificateEntry(String alias, Certificate cert) throws KeyStoreException
If the given alias identifies an existing entry created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, the trusted certificate in the existing entry is overridden by the given certificate.
If the given alias already exists in this keystore and identifies a
trusted certificate entry
, the certificate associated with it is overridden by the given certificate.
public abstract void engineDeleteEntry(String alias) throws KeyStoreException
public abstract Enumeration engineAliases()
public abstract boolean engineContainsAlias(String alias)
public abstract int engineSize()
public abstract boolean engineIsKeyEntry(String alias)
public abstract boolean engineIsCertificateEntry(String alias)
public abstract String engineGetCertificateAlias(Certificate cert)
This method attempts to match the given certificate with each keystore entry.
If the entry being considered was created by a call to setCertificateEntry, or created by a call to setEntry with a TrustedCertificateEntry, then the given certificate is compared to that entry's certificate.
If the entry being considered is a
trusted certificate entry
, the given certificate is compared to that entry's certificate. If the entry being considered is a
key entry
, the given certificate is compared to the first element of that entry's certificate chain (if a chain exists).
If the entry being considered was created by a call to setKeyEntry, or created by a call to setEntry with a PrivateKeyEntry, then the given certificate is compared to the first element of that entry's certificate chain.
public abstract void engineStore(OutputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException
public void engineStore ( KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException
public abstract void engineLoad(InputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException
A password may be given to unlock the keystore (e.g. the keystore resides on a hardware token device), or to check the integrity of the keystore data. If a password is not given for integrity checking, then integrity checking is not performed.
If a password is given, it is used to check the integrity of the keystore data. Otherwise, the integrity of the keystore is not checked.
public void engineLoad ( KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException
Note that if this KeyStore has already been loaded, it is reinitialized and loaded again from the given parameter.
public KeyStore.EntryengineGetEntry ( String alias, KeyStore.ProtectionParameter protParam) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableEntryException
public void engineSetEntry ( String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) throws KeyStoreException
If an entry already exists for the specified alias, it is overridden.
public boolean engineEntryInstanceOf ( String alias, Class entryClass)