org.apache.http.ssl
Class SSLContextBuilder

java.lang.Object
  org.apache.http.ssl.SSLContextBuilder

@NotThreadSafe
public class SSLContextBuilder
extends 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

Constructor Summary

SSLContextBuilder()

Method Summary

SSLContext	build()
static SSLContextBuilder	create()
protected void	initSSLContext(SSLContext sslcontext, Collection<KeyManager> keyManagers, Collection<TrustManager> trustManagers, SecureRandom secureRandom)
SSLContextBuilder	loadKeyMaterial(File file, char[] storePassword, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(File file, char[] storePassword, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadKeyMaterial(KeyStore keystore, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(KeyStore keystore, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadKeyMaterial(URL url, char[] storePassword, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(URL url, char[] storePassword, char[] keyPassword, PrivateKeyStrategy aliasStrategy)
SSLContextBuilder	loadTrustMaterial(File file)
SSLContextBuilder	loadTrustMaterial(File file, char[] storePassword)
SSLContextBuilder	loadTrustMaterial(File file, char[] storePassword, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(KeyStore truststore, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(URL url, char[] storePassword)
SSLContextBuilder	loadTrustMaterial(URL url, char[] storePassword, TrustStrategy trustStrategy)
SSLContextBuilder	setSecureRandom(SecureRandom secureRandom)
SSLContextBuilder	useProtocol(String protocol)

Methods inherited from class java.lang.Object

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

Constructor Detail

SSLContextBuilder

public SSLContextBuilder()

Method Detail

create

public static SSLContextBuilder create()

useProtocol

public SSLContextBuilder useProtocol(String protocol)

setSecureRandom

public SSLContextBuilder setSecureRandom(SecureRandom secureRandom)

loadTrustMaterial

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

Throws:

NoSuchAlgorithmException

KeyStoreException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(TrustStrategy trustStrategy)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException

Throws:

NoSuchAlgorithmException

KeyStoreException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(File file,
                                           char[] storePassword,
                                           TrustStrategy trustStrategy)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException,
                                           CertificateException,
                                           IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(File file,
                                           char[] storePassword)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException,
                                           CertificateException,
                                           IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(File file)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException,
                                           CertificateException,
                                           IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(URL url,
                                           char[] storePassword,
                                           TrustStrategy trustStrategy)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException,
                                           CertificateException,
                                           IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

loadTrustMaterial

public SSLContextBuilder loadTrustMaterial(URL url,
                                           char[] storePassword)
                                    throws NoSuchAlgorithmException,
                                           KeyStoreException,
                                           CertificateException,
                                           IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

loadKeyMaterial

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

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

loadKeyMaterial

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

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

loadKeyMaterial

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

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

CertificateException

IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(File file,
                                         char[] storePassword,
                                         char[] keyPassword)
                                  throws NoSuchAlgorithmException,
                                         KeyStoreException,
                                         UnrecoverableKeyException,
                                         CertificateException,
                                         IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

CertificateException

IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(URL url,
                                         char[] storePassword,
                                         char[] keyPassword,
                                         PrivateKeyStrategy aliasStrategy)
                                  throws NoSuchAlgorithmException,
                                         KeyStoreException,
                                         UnrecoverableKeyException,
                                         CertificateException,
                                         IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

CertificateException

IOException

loadKeyMaterial

public SSLContextBuilder loadKeyMaterial(URL url,
                                         char[] storePassword,
                                         char[] keyPassword)
                                  throws NoSuchAlgorithmException,
                                         KeyStoreException,
                                         UnrecoverableKeyException,
                                         CertificateException,
                                         IOException

Throws:

NoSuchAlgorithmException

KeyStoreException

UnrecoverableKeyException

CertificateException

IOException

initSSLContext

protected void initSSLContext(SSLContext sslcontext,
                              Collection<KeyManager> keyManagers,
                              Collection<TrustManager> trustManagers,
                              SecureRandom secureRandom)
                       throws KeyManagementException

Throws:

KeyManagementException

build

public SSLContext build()
                 throws NoSuchAlgorithmException,
                        KeyManagementException

Throws:

NoSuchAlgorithmException

KeyManagementException