org.apache.http.ssl

Class SSLContextBuilder

java.lang.Object

org.apache.http.ssl.SSLContextBuilder

@NotThreadSafe
public class SSLContextBuilder
extends java.lang.Object

Builder for SSLContext instances.

Please note: the default Oracle JSSE implementation of SSLContext.init(KeyManager[], TrustManager[], SecureRandom) accepts multiple key and trust managers, however only only first matching type is ever used. See for example: SSLContext.html#init

Since:

4.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SSLContextBuilder.KeyManagerDelegate
(package private) static class	SSLContextBuilder.TrustManagerDelegate

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	TLS

Constructor Summary

Constructors

Constructor and Description
SSLContextBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
javax.net.ssl.SSLContext	build()
static SSLContextBuilder	create()
protected void	initSSLContext(javax.net.ssl.SSLContext sslcontext, java.util.Collection<javax.net.ssl.KeyManager> keyManagers, java.util.Collection<javax.net.ssl.TrustManager> trustManagers, java.security.SecureRandom secureRandom)
SSLContextBuilder	loadKeyMaterial(java.io.File file, char[] storePassword, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(java.io.File file, char[] storePassword, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadKeyMaterial(java.security.KeyStore keystore, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(java.security.KeyStore keystore, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadKeyMaterial(java.net.URL url, char[] storePassword, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(java.net.URL url, char[] storePassword, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadTrustMaterial(java.io.File file)
SSLContextBuilder	loadTrustMaterial(java.io.File file, char[] storePassword)
SSLContextBuilder	loadTrustMaterial(java.io.File file, char[] storePassword, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(java.security.KeyStore truststore, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(java.net.URL url, char[] storePassword)
SSLContextBuilder	loadTrustMaterial(java.net.URL url, char[] storePassword, TrustStrategy trustStrategy)
SSLContextBuilder	setSecureRandom(java.security.SecureRandom secureRandom)
SSLContextBuilder	useProtocol(java.lang.String protocol)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TLS

static final java.lang.String TLS

See Also:

Constant Field Values

Constructor Detail

SSLContextBuilder

public SSLContextBuilder()

Method Detail

create

public static SSLContextBuilder create()

useProtocol

public SSLContextBuilder useProtocol(java.lang.String protocol)

setSecureRandom

public SSLContextBuilder setSecureRandom(java.security.SecureRandom secureRandom)

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.security.KeyStore truststore,
                                  TrustStrategy trustStrategy)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(TrustStrategy trustStrategy)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.io.File file,
                                  char[] storePassword,
                                  TrustStrategy trustStrategy)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException,
                                           java.security.cert.CertificateException,
                                           java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.io.IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.io.File file,
                                  char[] storePassword)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException,
                                           java.security.cert.CertificateException,
                                           java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.io.IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.io.File file)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException,
                                           java.security.cert.CertificateException,
                                           java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.io.IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.net.URL url,
                                  char[] storePassword,
                                  TrustStrategy trustStrategy)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException,
                                           java.security.cert.CertificateException,
                                           java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.io.IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(java.net.URL url,
                                  char[] storePassword)
                                    throws java.security.NoSuchAlgorithmException,
                                           java.security.KeyStoreException,
                                           java.security.cert.CertificateException,
                                           java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.cert.CertificateException

java.io.IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.security.KeyStore keystore,
                                char[] keyPassword,
                                PrivateKeyStrategy aliasStrategy)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.security.KeyStore keystore,
                                char[] keyPassword)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.io.File file,
                                char[] storePassword,
                                char[] keyPassword,
                                PrivateKeyStrategy aliasStrategy)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException,
                                         java.security.cert.CertificateException,
                                         java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.cert.CertificateException

java.io.IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.io.File file,
                                char[] storePassword,
                                char[] keyPassword)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException,
                                         java.security.cert.CertificateException,
                                         java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.cert.CertificateException

java.io.IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.net.URL url,
                                char[] storePassword,
                                char[] keyPassword,
                                PrivateKeyStrategy aliasStrategy)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException,
                                         java.security.cert.CertificateException,
                                         java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.cert.CertificateException

java.io.IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(java.net.URL url,
                                char[] storePassword,
                                char[] keyPassword)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.security.KeyStoreException,
                                         java.security.UnrecoverableKeyException,
                                         java.security.cert.CertificateException,
                                         java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.cert.CertificateException

java.io.IOException

initSSLContext

protected void initSSLContext(javax.net.ssl.SSLContext sslcontext,
                  java.util.Collection<javax.net.ssl.KeyManager> keyManagers,
                  java.util.Collection<javax.net.ssl.TrustManager> trustManagers,
                  java.security.SecureRandom secureRandom)
                       throws java.security.KeyManagementException

Throws:

java.security.KeyManagementException

build

public javax.net.ssl.SSLContext build()
                               throws java.security.NoSuchAlgorithmException,
                                      java.security.KeyManagementException

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyManagementException