Package org.apache.karaf.jaas.config

Interface KeystoreManager

All Known Implementing Classes:

OsgiKeystoreManager

public interface KeystoreManager

Based on http://svn.apache.org/repos/asf/geronimo/trunk/modules/management/ src/java/org/apache/geronimo/management/geronimo/KeystoreManager.java

Method Summary

Modifier and Type	Method	Description
SSLContext	createSSLContext(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore)	Get a SSLContext using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
SSLContext	createSSLContext(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore, long timeout)	Get a SSLContext using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
SSLSocketFactory	createSSLFactory(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore)	Get a SocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
SSLSocketFactory	createSSLFactory(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore, long timeout)	Get a SocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
SSLServerSocketFactory	createSSLServerFactory(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore)	Get a ServerSocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
SSLServerSocketFactory	createSSLServerFactory(String provider, String protocol, String algorithm, String keyStore, String keyAlias, String trustStore, long timeout)	Get a ServerSocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.
KeystoreInstance	getKeystore(String name)

Method Detail

getKeystore

KeystoreInstance getKeystore(String name)

createSSLContext

SSLContext createSSLContext(String provider,
                            String protocol,
                            String algorithm,
                            String keyStore,
                            String keyAlias,
                            String trustStore)
                     throws GeneralSecurityException

Get a SSLContext using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - the SSL provider to use.

protocol - the SSL protocol to use.

algorithm - the SSL algorithm to use.

keyStore - the key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - the name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - The trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

Returns:

the SSLContext.

Throws:

KeystoreIsLocked - Occurs when the requested key keystore cannot be used because it has not been unlocked.

KeyIsLocked - Occurs when the requested private key in the key keystore cannot be used because it has not been unlocked.

GeneralSecurityException

createSSLContext

SSLContext createSSLContext(String provider,
                            String protocol,
                            String algorithm,
                            String keyStore,
                            String keyAlias,
                            String trustStore,
                            long timeout)
                     throws GeneralSecurityException

Get a SSLContext using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - the SSL provider to use.

protocol - The SSL protocol to use

algorithm - The SSL algorithm to use

keyStore - The key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - The name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - The trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

timeout - Amount of time waiting for the keyStore and keyAlias to be available.

Returns:

the SSLContext.

Throws:

GeneralSecurityException - General security failure.

createSSLServerFactory

SSLServerSocketFactory createSSLServerFactory(String provider,
                                              String protocol,
                                              String algorithm,
                                              String keyStore,
                                              String keyAlias,
                                              String trustStore)
                                       throws GeneralSecurityException

Get a ServerSocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - the SSL provider to use.

protocol - The SSL protocol to use.

algorithm - The SSL algorithm to use.

keyStore - The key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - The name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - The trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

Returns:

the SSLServerSocketFactory.

Throws:

GeneralSecurityException - General security failure.

createSSLServerFactory

SSLServerSocketFactory createSSLServerFactory(String provider,
                                              String protocol,
                                              String algorithm,
                                              String keyStore,
                                              String keyAlias,
                                              String trustStore,
                                              long timeout)
                                       throws GeneralSecurityException

Get a ServerSocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - the SSL provider to use.

protocol - The SSL protocol to use.

algorithm - The SSL algorithm to use.

keyStore - The key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - The name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - The trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

timeout - Amount of time to wait for keyStore and keyAlias to be available.

Returns:

the SSLServerSocketFactory.

Throws:

GeneralSecurityException - General security failure.

createSSLFactory

SSLSocketFactory createSSLFactory(String provider,
                                  String protocol,
                                  String algorithm,
                                  String keyStore,
                                  String keyAlias,
                                  String trustStore)
                           throws GeneralSecurityException

Get a SocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - the SSL provider to use, or null for the default.

protocol - the SSL protocol to use.

algorithm - the SSL algorithm to use.

keyStore - the key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - the name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - the trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

Returns:

the SSLSocketFactory.

Throws:

KeystoreIsLocked - Occurs when the requested key keystore cannot be used because it has not been unlocked.

KeyIsLocked - Occurs when the requested private key in the key keystore cannot be used because it has not been unlocked.

GeneralSecurityException - General security failure.

createSSLFactory

SSLSocketFactory createSSLFactory(String provider,
                                  String protocol,
                                  String algorithm,
                                  String keyStore,
                                  String keyAlias,
                                  String trustStore,
                                  long timeout)
                           throws GeneralSecurityException

Get a SocketFactory using one Keystore to access the private key and another to provide the list of trusted certificate authorities.

Parameters:

provider - The SSL provider to use, or null for the default

protocol - The SSL protocol to use

algorithm - The SSL algorithm to use

keyStore - The key keystore name as provided by listKeystores. The KeystoreInstance for this keystore must be unlocked.

keyAlias - The name of the private key in the keystore. The KeystoreInstance for this keystore must have unlocked this key.

trustStore - The trust keystore name as provided by listKeystores. The KeystoreInstance for this keystore must have unlocked this key.

timeout - Amount of time to wait for keyStore and keyAlias to be available.

Returns:

the SSLSocketFactory.

Throws:

KeystoreIsLocked - Occurs when the requested key keystore cannot be used because it has not been unlocked.

KeyIsLocked - Occurs when the requested private key in the key keystore cannot be used because it has not been unlocked.

GeneralSecurityException - General security failure.