java.security.KeyStoreSpi

public abstract class java.security

KeyStoreSpi

Java SE 6

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.

version	1.22, 04/07/06
since	1.2
See also	java.security.KeyStore

Constructors

public

KeyStoreSpi()

Methods

abstract public Enumeration

engineAliases() Details

Lists all the alias names of this keystore.

return

enumeration of the alias names

abstract public boolean

engineContainsAlias(String alias) Details

Checks if the given alias exists in this keystore.

alias	the alias name
return	true if the alias exists, false otherwise

abstract public void

engineDeleteEntry(String alias) throws KeyStoreException Details

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

alias	the alias name
Throws	KeyStoreException: if the entry cannot be removed.

public boolean

engineEntryInstanceOf(String alias, Class entryClass) Details

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

alias	the alias name
entryClass	the entry class
return	true if the keystore `Entry` for the specified `alias` is an instance or subclass of the specified `entryClass`, false otherwise
since	1.5

abstract public Certificate

engineGetCertificate(String alias) Details

Returns the certificate associated with the given 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 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.

alias the alias name

return the certificate, or null if the given alias does not exist or does not contain a certificate.

abstract public String

engineGetCertificateAlias(Certificate cert) Details

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

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

cert the certificate to match with.

return the alias name of the first entry with matching certificate, or null if no such entry exists in this keystore.

abstract public Certificate[]

engineGetCertificateChain(String alias) Details

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.

alias	the alias name
return	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

abstract public Date

engineGetCreationDate(String alias) Details

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

alias	the alias name
return	the creation date of this entry, or null if the given alias does not exist

public KeyStore.Entry

engineGetEntry(String alias, KeyStore.ProtectionParameter protParam) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableEntryException Details

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

alias	get the `KeyStore.Entry` for this alias
protParam	the `ProtectionParameter` used to protect the `Entry`, which may be `null`
return	the `KeyStore.Entry` for the specified alias, or `null` if there is no such entry
Throws	KeyStoreException: if the operation failed
Throws	NoSuchAlgorithmException: if the algorithm for recovering the entry cannot be found
Throws	UnrecoverableEntryException: if the specified `protParam` were insufficient or invalid
Throws	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

abstract public Key

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

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.

alias	the alias name
password	the password for recovering the key
return	the requested key, or null if the given alias does not exist or does not identify a key-related entry.
Throws	NoSuchAlgorithmException: if the algorithm for recovering the key cannot be found
Throws	UnrecoverableKeyException: if the key cannot be recovered (e.g., the given password is wrong).

abstract public boolean

engineIsCertificateEntry(String alias) Details

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.

alias	the alias for the keystore entry to be checked
return	true if the entry identified by the given alias contains a trusted certificate, false otherwise.

abstract public boolean

engineIsKeyEntry(String alias) Details

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.

alias	the alias for the keystore entry to be checked
return	true if the entry identified by the given alias is a key-related, false otherwise.

abstract public void

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

Loads the keystore from the given input stream.

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.

stream the input stream from which the keystore is loaded, or null

password the password used to check the integrity of the keystore, the password used to unlock the keystore, or null

Throws IOException: if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect. If the error is due to a wrong password, the cause of the IOException should be an UnrecoverableKeyException

Throws NoSuchAlgorithmException: if the algorithm used to check the integrity of the keystore cannot be found

Throws CertificateException: if any of the certificates in the keystore could not be loaded

public void

engineLoad(KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException Details

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.

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

Throws 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 cause of the IOException should be an UnrecoverableKeyException

Throws NoSuchAlgorithmException: if the algorithm used to check the integrity of the keystore cannot be found

Throws CertificateException: if any of the certificates in the keystore could not be loaded

since 1.5

abstract public void

engineSetCertificateEntry(String alias, Certificate cert) throws KeyStoreException Details

Assigns the given certificate to the given alias.

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.

alias the alias name

cert the certificate

Throws KeyStoreException: if the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

public void

engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) throws KeyStoreException Details

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.

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

abstract public void

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

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

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).

alias the alias name

key the key to be associated with the alias

password the password to protect the key

chain the certificate chain for the corresponding public key (only required if the given key is of type java.security.PrivateKey).

Throws KeyStoreException: if the given key cannot be protected, or this operation fails for some other reason

abstract public void

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

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

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).

alias the alias name

key the key (in protected format) to be associated with the alias

chain the certificate chain for the corresponding public key (only useful if the protected key is of type java.security.PrivateKey).

Throws KeyStoreException: if this operation fails.

abstract public int

engineSize() Details

Retrieves the number of entries in this keystore.

return

the number of entries in this keystore

abstract public void

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

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

stream	the output stream to which this keystore is written.
password	the password to generate the keystore integrity check
Throws	IOException: if there was an I/O problem with data
Throws	NoSuchAlgorithmException: if the appropriate data integrity algorithm could not be found
Throws	CertificateException: if any of the certificates included in the keystore data could not be stored

public void

engineStore(KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException Details

Stores this keystore using the given KeyStore.LoadStoreParmeter.

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
Throws	IOException: if there was an I/O problem with data
Throws	NoSuchAlgorithmException: if the appropriate data integrity algorithm could not be found
Throws	CertificateException: if any of the certificates included in the keystore data could not be stored
since	1.5

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6