com.sap.it.api.keystore

Interface KeystoreService

All Superinterfaces:

ITApi

public interface KeystoreService
extends ITApi

Public API to access key storage services.

Method Summary

Modifier and Type	Method and Description
Certificate	getCertificate(String alias) Returns the certificate associated with the given alias.
Certificate[]	getCertificateChain(String alias) Returns the certificate chain associated with the given alias.
Key	getKey(String alias) Returns the key associated with the given alias.
KeyManager	getKeyManager() Get a KeyManager implementation instance using the service.
KeyManager	getKeyManager(String alias) Get a KeyManager implementation instance using the service.
KeyManager[]	getKeyManagers() Get all KeyManager implementation instances using the service.
KeyManager[]	getKeyManagers(String alias) Get all KeyManager implementation instances using the service.
KeyPair	getKeyPair(String alias) Returns the key pair associated with the given alias.
TrustManager	getTrustManager() Get a trust manager implementation instance using the service for the default trust store.
TrustManager[]	getTrustManagers() Get all trust manager implementation instances using the service for the default trust store.

Method Detail

getKeyManager

KeyManager getKeyManager()
                  throws KeystoreException

Get a KeyManager implementation instance using the service.

Returns:

A KeyManager instance or null, if no key manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getKeyManager

KeyManager getKeyManager(String alias)
                  throws KeystoreException

Get a KeyManager implementation instance using the service.

Parameters:

alias - The alias name for the key.

Returns:

A KeyManager instance or null, if no key manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getKeyManagers

KeyManager[] getKeyManagers()
                     throws KeystoreException

Get all KeyManager implementation instances using the service.

Returns:

A KeyManager instance or null, if no key manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getKeyManagers

KeyManager[] getKeyManagers(String alias)
                     throws KeystoreException

Get all KeyManager implementation instances using the service.

Parameters:

alias - The alias name of the key.

Returns:

A KeyManager instance or null, if no key manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getTrustManager

TrustManager getTrustManager()
                      throws KeystoreException

Get a trust manager implementation instance using the service for the default trust store.

Returns:

A TrustManager instance or null, if no trust manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getTrustManagers

TrustManager[] getTrustManagers()
                         throws KeystoreException

Get all trust manager implementation instances using the service for the default trust store.

Returns:

A TrustManager instance or null, if no trust manager instance is available.

Throws:

KeystoreException - - if the KeyManagerFactory service reference is not found

getKey

Key getKey(String alias)
    throws KeystoreException

Returns the key associated with the given alias.

Parameters:

alias - the alias name

Returns:

the requested key, or null if the given alias does not exist or does not identify a key-related entry or the keystore service is not available

Throws:

IllegalStateException - if the algorithm for recovering the key cannot be found, if the key cannot be recovered.

KeystoreException - - if the KeyManagerFactory service reference is not found

getKeyPair

KeyPair getKeyPair(String alias)
            throws KeystoreException

Returns the key pair associated with the given alias.

Parameters:

alias - the alias name

Returns:

the request key pair, or null if the given alias does not exist or the alias does not refer to a private key

Throws:

IllegalStateException - if the algorithm for recovering the key cannot be found, if the key cannot be recovered, if the correspondent keystore has not been initialized (loaded).

KeystoreException - - if the KeyManagerFactory service reference is not found

getCertificate

Certificate getCertificate(String alias)
                    throws KeystoreException

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

Parameters:

alias - the alias name

Returns:

the certificate, or null if the given alias does not exist or does not contain a certificate or the keystore service is not available

Throws:

IllegalStateException - if the correspondent keystore has not been initialized (loaded)

KeystoreException - - if the KeyManagerFactory service reference is not found

getCertificateChain

Certificate[] getCertificateChain(String alias)
                           throws KeystoreException

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.

Parameters:

alias - the alias name

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 or the keystore service is not available

Throws:

IllegalStateException - if the keystore has not been initialized (loaded).

KeystoreException - - if the KeyManagerFactory service reference is not found