org.jboss.remoting.security
Interface SSLSocketBuilderMBean

All Known Implementing Classes:

SSLSocketBuilder

public interface SSLSocketBuilderMBean

Author:

Tom Elrod

Method Summary

void	create() create the service, do expensive operations etc
javax.net.ServerSocketFactory	createSSLServerSocketFactory() Will create a SSLServerSocketFactory.
javax.net.SocketFactory	createSSLSocketFactory() Will create a SSLSocketFactory.
void	destroy() destroy the service, tear down
java.lang.String	getKeyManagementAlgorithm() The algorithm for the key manager factory.
java.lang.String	getKeyStoreType() The type to be used for the key store.
java.lang.String	getSecureSocketProtocol() The protocol for the SSLContext.
boolean	getUseSSLServerSocketFactory() Return whether SSLServerSocketFactory.getDefault() will be used or not.
boolean	getUseSSLSocketFactory() Return whether SSLSocketFactory.getDefault() will be used or not.
void	setKeyManagementAlgorithm(java.lang.String keyManagementAlgorithm) The algorithm for the key manager factory.
void	setKeyPassword(java.lang.String passphrase) Sets the password to use for the keys within the key store.
void	setKeyStorePassword(java.lang.String passphrase) Sets the password to use for the key store.
void	setKeyStoreType(java.lang.String keyStoreType) The type to be used for the key store.
void	setKeyStoreURL(java.lang.String storeURL) This is the url string to the key store to use.
void	setSecureSocketProtocol(java.lang.String secureSocketProtocol) The protocol for the SSLContext.
void	setTrustStoreURL(java.lang.String storeURL) This is the url string to the trust store to use.
void	setUseSSLServerSocketFactory(boolean shouldUse) Will indicate if should use the SSLServerSocketFactory.getDefault() for getting the ServerSocketFactory to use (when calling createSSLServerSocketFactory()).
void	setUseSSLSocketFactory(boolean shouldUse) Will indicate if should use the SSLSocketFactory.getDefault() for getting the SocketFactory to use (when calling createSSLSocketFactory()).
void	start() start the service, create is already called
void	stop() stop the service

Method Detail

create

void create()
            throws java.lang.Exception

create the service, do expensive operations etc

Throws:

java.lang.Exception

start

void start()
           throws java.lang.Exception

start the service, create is already called

Throws:

java.lang.Exception

stop

void stop()

stop the service

destroy

void destroy()

destroy the service, tear down

setUseSSLServerSocketFactory

void setUseSSLServerSocketFactory(boolean shouldUse)

Will indicate if should use the SSLServerSocketFactory.getDefault() for getting the ServerSocketFactory to use (when calling createSSLServerSocketFactory()). If true, will allow for setting key store location (via javax.net.ssl.keyStore system property) and setting of the key store password (via javax.net.ssl.keyStorePassword system property) and no other configuration is needed (none of the other setters will need to be called and are in fact ignored). If set to false, will allow the custom setting of secure socket protocol, key management algorithm, key store type, key store url, key store password, and key password.

The default value is true.

NOTE: If this is not explicitly set to false, no customizations can be made and the default implementation provided by the JVM vendor being used will be executed.

Parameters:

shouldUse -

getUseSSLServerSocketFactory

boolean getUseSSLServerSocketFactory()

Return whether SSLServerSocketFactory.getDefault() will be used or not. See setUseSSLServerSocketFactory() for more information on what this means.

Returns:

setUseSSLSocketFactory

void setUseSSLSocketFactory(boolean shouldUse)

Will indicate if should use the SSLSocketFactory.getDefault() for getting the SocketFactory to use (when calling createSSLSocketFactory()). If true, will allow for setting trust store location (via Djavax.net.ssl.trustStore system property) and no other configuration is needed (none of the other setters will need to be called and are in fact ignored). If set to false, will allow the custom setting of secure socket protocol, key management algorithm, key store type, ant trust store url.

The default value is true.

NOTE: If this is not explicitly set to false, no customizations can be made and the default implementation provided by the JVM vendor being used will be executed.

Parameters:

shouldUse -

getUseSSLSocketFactory

boolean getUseSSLSocketFactory()

Return whether SSLSocketFactory.getDefault() will be used or not. See setUseSSLSocketFactory() for more information on what this means.

Returns:

getSecureSocketProtocol

java.lang.String getSecureSocketProtocol()

The protocol for the SSLContext. Some acceptable values are TLS, SSL, and SSLv3. Defaults to DEFAULT_SECURE_SOCKET_PROTOCOL.

setSecureSocketProtocol

void setSecureSocketProtocol(java.lang.String secureSocketProtocol)

The protocol for the SSLContext. Some acceptable values are TLS, SSL, and SSLv3. Defaults to DEFAULT_SECURE_SOCKET_PROTOCOL.

getKeyManagementAlgorithm

java.lang.String getKeyManagementAlgorithm()

The algorithm for the key manager factory. Defaults to DEFAULT_KEY_MANAGEMENT_ALGORITHM.

setKeyManagementAlgorithm

void setKeyManagementAlgorithm(java.lang.String keyManagementAlgorithm)

The algorithm for the key manager factory. Defaults to DEFAULT_KEY_MANAGEMENT_ALGORITHM.

getKeyStoreType

java.lang.String getKeyStoreType()

The type to be used for the key store. Defaults to DEFAULT_KEY_STORE_TYPE. Some acceptable values are JKS (Java Keystore - Sun's keystore format), JCEKS (Java Cryptography Extension keystore - More secure version of JKS), and PKCS12 (Public-Key Cryptography Standards #12 keystore - RSA's Personal Information Exchange Syntax Standard). These are not case sensitive.

setKeyStoreType

void setKeyStoreType(java.lang.String keyStoreType)

The type to be used for the key store. Defaults to DEFAULT_KEY_STORE_TYPE. Some acceptable values are JKS (Java Keystore - Sun's keystore format), JCEKS (Java Cryptography Extension keystore - More secure version of JKS), and PKCS12 (Public-Key Cryptography Standards #12 keystore - RSA's Personal Information Exchange Syntax Standard). These are not case sensitive.

setKeyStorePassword

void setKeyStorePassword(java.lang.String passphrase)

Sets the password to use for the key store. This only needs to be set if setUseSSLServerSocketFactory() is set to false (otherwise will be ignored). The value passed will also be used for the key password if it is not explicitly set.

Parameters:

passphrase -

setKeyPassword

void setKeyPassword(java.lang.String passphrase)

Sets the password to use for the keys within the key store. This only needs to be set if setUseSSLServerSocketFactory() is set to false (otherwise will be ignored). If this value is not set, but the key store password is, it will use that value for the key password.

Parameters:

passphrase -

createSSLServerSocketFactory

javax.net.ServerSocketFactory createSSLServerSocketFactory()
                                                           throws java.io.IOException,
                                                                  java.security.NoSuchAlgorithmException,
                                                                  java.security.KeyStoreException,
                                                                  java.security.cert.CertificateException,
                                                                  java.security.UnrecoverableKeyException,
                                                                  java.security.KeyManagementException

Will create a SSLServerSocketFactory. If the useSSLServerSocketFactory property is set to true (which is the default), it will use SSLServerSocketFactory.getDefault() to get the server socket factory. Otherwise, if property is false, will use all the other custom properties that have been set to create a custom server socket factory.

Returns:

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.security.UnrecoverableKeyException

java.security.KeyManagementException

createSSLSocketFactory

javax.net.SocketFactory createSSLSocketFactory()
                                               throws java.io.IOException,
                                                      java.security.NoSuchAlgorithmException,
                                                      java.security.KeyStoreException,
                                                      java.security.cert.CertificateException,
                                                      java.security.KeyManagementException

Will create a SSLSocketFactory. If the useSSLSocketFactory property is set to true (which is the default), it will use SSLSocketFactory.getDefault() to get the socket factory. Otherwise, if property is false, will use all the other custom properties that have been set to create a custom server socket factory.

Returns:

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.security.KeyManagementException

setKeyStoreURL

void setKeyStoreURL(java.lang.String storeURL)
                    throws java.io.IOException

This is the url string to the key store to use. If UseSSLServerSocketFactory is true, this will be ignored and will use the value set by the javax.net.ssl.keyStore system property. Otherwise, if UseSSLServerSocketFactory is false, this must be set.

Parameters:

storeURL -

Throws:

java.io.IOException

setTrustStoreURL

void setTrustStoreURL(java.lang.String storeURL)
                      throws java.io.IOException

This is the url string to the trust store to use. If UseSSLSocketFactory is true, this will be ignored and will use the value set by the javax.net.ssl.trustStore system property. Otherwise, if UseSSLSocketFactory is false, this must be set.

Parameters:

storeURL -

Throws:

java.io.IOException