Package org.apache.http.ssl

Class SSLContextBuilder

java.lang.Object

org.apache.http.ssl.SSLContextBuilder

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

TODO Specify which Oracle JSSE versions the above has been verified.

Since:

4.4

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	keyManagerFactoryAlgorithm
private java.util.Set<javax.net.ssl.KeyManager>	keyManagers
private java.lang.String	keyStoreType
private java.lang.String	protocol
private java.security.Provider	provider
private java.security.SecureRandom	secureRandom
(package private) static java.lang.String	TLS
private java.lang.String	trustManagerFactoryAlgorithm
private java.util.Set<javax.net.ssl.TrustManager>	trustManagers

Constructor Summary

Constructors

Constructor	Description
SSLContextBuilder()

Method Summary

Modifier and Type	Method	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.net.URL url, char[] storePassword, char[] keyPassword)
SSLContextBuilder	loadKeyMaterial(java.net.URL url, 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	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.net.URL url, char[] storePassword)
SSLContextBuilder	loadTrustMaterial(java.net.URL url, char[] storePassword, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(java.security.KeyStore truststore, TrustStrategy trustStrategy)
SSLContextBuilder	loadTrustMaterial(TrustStrategy trustStrategy)
SSLContextBuilder	setKeyManagerFactoryAlgorithm(java.lang.String keyManagerFactoryAlgorithm)	Sets the key manager factory algorithm name.
SSLContextBuilder	setKeyStoreType(java.lang.String keyStoreType)	Sets the key store type.
SSLContextBuilder	setProtocol(java.lang.String protocol)	Sets the SSLContext protocol algorithm name.
SSLContextBuilder	setProvider(java.lang.String name)
SSLContextBuilder	setProvider(java.security.Provider provider)
SSLContextBuilder	setSecureRandom(java.security.SecureRandom secureRandom)
SSLContextBuilder	setTrustManagerFactoryAlgorithm(java.lang.String trustManagerFactoryAlgorithm)	Sets the trust manager factory algorithm name.
java.lang.String	toString()
SSLContextBuilder	useProtocol(java.lang.String protocol)	Deprecated. Use setProtocol(String).

Methods inherited from class java.lang.Object

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

Field Detail

TLS

static final java.lang.String TLS

See Also:

Constant Field Values

protocol

private java.lang.String protocol

keyManagers

private final java.util.Set<javax.net.ssl.KeyManager> keyManagers

keyManagerFactoryAlgorithm

private java.lang.String keyManagerFactoryAlgorithm

keyStoreType

private java.lang.String keyStoreType

trustManagers

private final java.util.Set<javax.net.ssl.TrustManager> trustManagers

trustManagerFactoryAlgorithm

private java.lang.String trustManagerFactoryAlgorithm

secureRandom

private java.security.SecureRandom secureRandom

provider

private java.security.Provider provider

Constructor Detail

SSLContextBuilder

public SSLContextBuilder()

Method Detail

create

public static SSLContextBuilder create()

useProtocol

@Deprecated
public SSLContextBuilder useProtocol(java.lang.String protocol)

Deprecated.

Use setProtocol(String).

Sets the SSLContext protocol algorithm name.

Parameters:

protocol - the SSLContext protocol algorithm name of the requested protocol. See the SSLContext section in the Java Cryptography Architecture Standard Algorithm Name Documentation for more information.

Returns:

this builder

See Also:

Java Cryptography Architecture Standard Algorithm Name Documentation

setProtocol

public SSLContextBuilder setProtocol(java.lang.String protocol)

Sets the SSLContext protocol algorithm name.

Parameters:

protocol - the SSLContext protocol algorithm name of the requested protocol. See the SSLContext section in the Java Cryptography Architecture Standard Algorithm Name Documentation for more information.

Returns:

this builder

Since:

4.4.7

See Also:

Java Cryptography Architecture Standard Algorithm Name Documentation

setSecureRandom

public SSLContextBuilder setSecureRandom(java.security.SecureRandom secureRandom)

setProvider

public SSLContextBuilder setProvider(java.security.Provider provider)

setProvider

public SSLContextBuilder setProvider(java.lang.String name)

setKeyStoreType

public SSLContextBuilder setKeyStoreType(java.lang.String keyStoreType)

Sets the key store type.

Parameters:

keyStoreType - the SSLkey store type. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for more information.

Returns:

this builder

Since:

4.4.7

See Also:

Java Cryptography Architecture Standard Algorithm Name Documentation

setKeyManagerFactoryAlgorithm

public SSLContextBuilder setKeyManagerFactoryAlgorithm(java.lang.String keyManagerFactoryAlgorithm)

Sets the key manager factory algorithm name.

Parameters:

keyManagerFactoryAlgorithm - the key manager factory algorithm name of the requested protocol. See the KeyManagerFactory section in the Java Cryptography Architecture Standard Algorithm Name Documentation for more information.

Returns:

this builder

Since:

4.4.7

See Also:

Java Cryptography Architecture Standard Algorithm Name Documentation

setTrustManagerFactoryAlgorithm

public SSLContextBuilder setTrustManagerFactoryAlgorithm(java.lang.String trustManagerFactoryAlgorithm)

Sets the trust manager factory algorithm name.

Parameters:

trustManagerFactoryAlgorithm - the trust manager algorithm name of the requested protocol. See the TrustManagerFactory section in the Java Cryptography Architecture Standard Algorithm Name Documentation for more information.

Returns:

this builder

Since:

4.4.7

See Also:

Java Cryptography Architecture Standard Algorithm Name Documentation

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object