Package nl.altindag.ssl

Class SSLFactory.Builder

java.lang.Object

nl.altindag.ssl.SSLFactory.Builder

Enclosing class:

SSLFactory

public static class SSLFactory.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SSLFactory	build()
SSLFactory.Builder	withCiphers(String... ciphers)
SSLFactory.Builder	withDefaultTrustMaterial()
SSLFactory.Builder	withDummyIdentityMaterial()
SSLFactory.Builder	withDummyTrustMaterial()
<T extends HostnameVerifier> SSLFactory.Builder	withHostnameVerifier(T hostnameVerifier)
SSLFactory.Builder	withHostnameVerifierEnhancer(Predicate<HostnameVerifierParameters> hostnameVerifierParametersValidator)
SSLFactory.Builder	withIdentityMaterial(InputStream identityStream, char[] identityStorePassword)
SSLFactory.Builder	withIdentityMaterial(InputStream identityStream, char[] identityStorePassword, char[] identityPassword)
SSLFactory.Builder	withIdentityMaterial(InputStream identityStream, char[] identityStorePassword, char[] identityPassword, String identityStoreType)
SSLFactory.Builder	withIdentityMaterial(InputStream identityStream, char[] identityStorePassword, String identityStoreType)
SSLFactory.Builder	withIdentityMaterial(String identityStorePath, char[] identityStorePassword)
SSLFactory.Builder	withIdentityMaterial(String identityStorePath, char[] identityStorePassword, char[] identityPassword)
SSLFactory.Builder	withIdentityMaterial(String identityStorePath, char[] identityStorePassword, char[] identityPassword, String identityStoreType)
SSLFactory.Builder	withIdentityMaterial(String identityStorePath, char[] identityStorePassword, String identityStoreType)
SSLFactory.Builder	withIdentityMaterial(Path identityStorePath, char[] identityStorePassword)
SSLFactory.Builder	withIdentityMaterial(Path identityStorePath, char[] identityStorePassword, char[] identityPassword)
SSLFactory.Builder	withIdentityMaterial(Path identityStorePath, char[] identityStorePassword, char[] identityPassword, String identityStoreType)
SSLFactory.Builder	withIdentityMaterial(Path identityStorePath, char[] identityStorePassword, String identityStoreType)
<T extends Certificate> SSLFactory.Builder	withIdentityMaterial(Key privateKey, char[] privateKeyPassword, String alias, List<T> certificateChain)
<T extends Certificate> SSLFactory.Builder	withIdentityMaterial(Key privateKey, char[] privateKeyPassword, String alias, T... certificateChain)
<T extends Certificate> SSLFactory.Builder	withIdentityMaterial(Key privateKey, char[] privateKeyPassword, List<T> certificateChain)
<T extends Certificate> SSLFactory.Builder	withIdentityMaterial(Key privateKey, char[] privateKeyPassword, T... certificateChain)
SSLFactory.Builder	withIdentityMaterial(KeyStore identityStore, char[] identityPassword)
<T extends X509KeyManager> SSLFactory.Builder	withIdentityMaterial(T keyManager)
SSLFactory.Builder	withIdentityRoute(String alias, String... hosts)
SSLFactory.Builder	withIdentityRoute(Map<String,List<String>> aliasesToHosts)
SSLFactory.Builder	withInflatableTrustMaterial()
SSLFactory.Builder	withInflatableTrustMaterial(Path trustStorePath, char[] trustStorePassword, String trustStoreType, BiPredicate<X509Certificate[],String> certificateAndAuthTypeTrustPredicate)	Deprecated.
SSLFactory.Builder	withInflatableTrustMaterial(Path trustStorePath, char[] trustStorePassword, String trustStoreType, Predicate<TrustManagerParameters> trustManagerParametersPredicate)
SSLFactory.Builder	withLoggingIdentityMaterial()
SSLFactory.Builder	withLoggingTrustMaterial()
SSLFactory.Builder	withNeedClientAuthentication()
SSLFactory.Builder	withNeedClientAuthentication(boolean needClientAuthentication)
SSLFactory.Builder	withProtocols(String... protocols)
<T extends SecureRandom> SSLFactory.Builder	withSecureRandom(T secureRandom)
SSLFactory.Builder	withSecurityProvider(String securityProviderName)
<T extends Provider> SSLFactory.Builder	withSecurityProvider(T securityProvider)
SSLFactory.Builder	withSessionCacheSize(int cacheSizeInBytes)
SSLFactory.Builder	withSessionTimeout(int timeoutInSeconds)
SSLFactory.Builder	withSslContextAlgorithm(String sslContextAlgorithm)
SSLFactory.Builder	withSwappableIdentityMaterial()	Enables the possibility to swap the underlying KeyManager at runtime.
SSLFactory.Builder	withSwappableTrustMaterial()	Enables the possibility to swap the underlying TrustManager at runtime.
SSLFactory.Builder	withSystemPropertyDerivedCiphers()
SSLFactory.Builder	withSystemPropertyDerivedIdentityMaterial()
SSLFactory.Builder	withSystemPropertyDerivedProtocols()
SSLFactory.Builder	withSystemPropertyDerivedTrustMaterial()
SSLFactory.Builder	withSystemTrustMaterial()
SSLFactory.Builder	withTrustEnhancer(Predicate<TrustManagerParameters> validator)
SSLFactory.Builder	withTrustEnhancer(ChainAndAuthTypeValidator validator)	Deprecated.
SSLFactory.Builder	withTrustEnhancer(ChainAndAuthTypeWithSocketValidator validator)	Deprecated.
SSLFactory.Builder	withTrustEnhancer(ChainAndAuthTypeWithSSLEngineValidator validator)	Deprecated.
SSLFactory.Builder	withTrustingAllCertificatesWithoutValidation()
SSLFactory.Builder	withTrustMaterial(InputStream trustStoreStream, char[] trustStorePassword)
SSLFactory.Builder	withTrustMaterial(InputStream trustStoreStream, char[] trustStorePassword, String trustStoreType)
SSLFactory.Builder	withTrustMaterial(InputStream trustStoreStream, char[] trustStorePassword, String trustStoreType, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(InputStream trustStoreStream, char[] trustStorePassword, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(String trustStorePath, char[] trustStorePassword)
SSLFactory.Builder	withTrustMaterial(String trustStorePath, char[] trustStorePassword, String trustStoreType)
SSLFactory.Builder	withTrustMaterial(String trustStorePath, char[] trustStorePassword, String trustStoreType, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(String trustStorePath, char[] trustStorePassword, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(Path trustStorePath, char[] trustStorePassword)
SSLFactory.Builder	withTrustMaterial(Path trustStorePath, char[] trustStorePassword, String trustStoreType)
SSLFactory.Builder	withTrustMaterial(Path trustStorePath, char[] trustStorePassword, String trustStoreType, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(Path trustStorePath, char[] trustStorePassword, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(KeyStore trustStore)
SSLFactory.Builder	withTrustMaterial(KeyStore trustStore, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
<T extends Certificate> SSLFactory.Builder	withTrustMaterial(List<T> certificates)
<T extends Certificate> SSLFactory.Builder	withTrustMaterial(List<T> certificates, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withTrustMaterial(Set<X509Certificate> certificates, TrustAnchorTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
<T extends X509TrustManager> SSLFactory.Builder	withTrustMaterial(T trustManager)
<T extends Certificate> SSLFactory.Builder	withTrustMaterial(T... certificates)
<T extends Certificate> SSLFactory.Builder	withTrustMaterial(T[] certificates, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
<T extends X509TrustManager> SSLFactory.Builder	withTrustMaterial(T trustManager, TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)
SSLFactory.Builder	withUnsafeHostnameVerifier()
SSLFactory.Builder	withUnsafeTrustMaterial()	A shorter method for using the unsafe trust material
SSLFactory.Builder	withWantClientAuthentication()
SSLFactory.Builder	withWantClientAuthentication(boolean wantClientAuthentication)

Methods inherited from class java.lang.Object

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

Method Detail

withSystemTrustMaterial

public SSLFactory.Builder withSystemTrustMaterial()

withDefaultTrustMaterial

public SSLFactory.Builder withDefaultTrustMaterial()

withSystemPropertyDerivedTrustMaterial

public SSLFactory.Builder withSystemPropertyDerivedTrustMaterial()

withUnsafeTrustMaterial

public SSLFactory.Builder withUnsafeTrustMaterial()

A shorter method for using the unsafe trust material

Returns:

SSLFactory.Builder

See Also:

withTrustingAllCertificatesWithoutValidation()

withDummyTrustMaterial

public SSLFactory.Builder withDummyTrustMaterial()

withSwappableTrustMaterial

public SSLFactory.Builder withSwappableTrustMaterial()

Enables the possibility to swap the underlying TrustManager at runtime. After this option has been enabled the TrustManager can be swapped with TrustManagerUtils#swapTrustManager(swappableTrustManager, newTrustManager)

Returns:

SSLFactory.Builder

withLoggingTrustMaterial

public SSLFactory.Builder withLoggingTrustMaterial()

withTrustMaterial

public <T extends X509TrustManager> SSLFactory.Builder withTrustMaterial(T trustManager)

withTrustMaterial

public <T extends ManagerFactoryParameters> SSLFactory.Builder withTrustMaterial(T managerFactoryParameters)

withTrustMaterial

public <T extends X509TrustManager> SSLFactory.Builder withTrustMaterial(T trustManager,
                                                                         TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public <T extends TrustManagerFactory> SSLFactory.Builder withTrustMaterial(T trustManagerFactory)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(String trustStorePath,
                                            char[] trustStorePassword)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(String trustStorePath,
                                            char[] trustStorePassword,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(String trustStorePath,
                                            char[] trustStorePassword,
                                            String trustStoreType)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(String trustStorePath,
                                            char[] trustStorePassword,
                                            String trustStoreType,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(Path trustStorePath,
                                            char[] trustStorePassword)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(Path trustStorePath,
                                            char[] trustStorePassword,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(Path trustStorePath,
                                            char[] trustStorePassword,
                                            String trustStoreType)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(Path trustStorePath,
                                            char[] trustStorePassword,
                                            String trustStoreType,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(InputStream trustStoreStream,
                                            char[] trustStorePassword)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(InputStream trustStoreStream,
                                            char[] trustStorePassword,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(InputStream trustStoreStream,
                                            char[] trustStorePassword,
                                            String trustStoreType)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(InputStream trustStoreStream,
                                            char[] trustStorePassword,
                                            String trustStoreType,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(KeyStore trustStore)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(KeyStore trustStore,
                                            TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public SSLFactory.Builder withTrustMaterial(Set<X509Certificate> certificates,
                                            TrustAnchorTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

@SafeVarargs
public final <T extends Certificate> SSLFactory.Builder withTrustMaterial(T... certificates)

withTrustMaterial

public final <T extends Certificate> SSLFactory.Builder withTrustMaterial(T[] certificates,
                                                                          TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withTrustMaterial

public <T extends Certificate> SSLFactory.Builder withTrustMaterial(List<T> certificates)

withTrustMaterial

public <T extends Certificate> SSLFactory.Builder withTrustMaterial(List<T> certificates,
                                                                    TrustStoreTrustOptions<? extends CertPathTrustManagerParameters> trustOptions)

withSystemPropertyDerivedIdentityMaterial

public SSLFactory.Builder withSystemPropertyDerivedIdentityMaterial()

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(String identityStorePath,
                                               char[] identityStorePassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(String identityStorePath,
                                               char[] identityStorePassword,
                                               char[] identityPassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(String identityStorePath,
                                               char[] identityStorePassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(String identityStorePath,
                                               char[] identityStorePassword,
                                               char[] identityPassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(Path identityStorePath,
                                               char[] identityStorePassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(Path identityStorePath,
                                               char[] identityStorePassword,
                                               char[] identityPassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(Path identityStorePath,
                                               char[] identityStorePassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(Path identityStorePath,
                                               char[] identityStorePassword,
                                               char[] identityPassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(InputStream identityStream,
                                               char[] identityStorePassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(InputStream identityStream,
                                               char[] identityStorePassword,
                                               char[] identityPassword)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(InputStream identityStream,
                                               char[] identityStorePassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(InputStream identityStream,
                                               char[] identityStorePassword,
                                               char[] identityPassword,
                                               String identityStoreType)

withIdentityMaterial

public SSLFactory.Builder withIdentityMaterial(KeyStore identityStore,
                                               char[] identityPassword)

withIdentityMaterial

@SafeVarargs
public final <T extends Certificate> SSLFactory.Builder withIdentityMaterial(Key privateKey,
                                                                             char[] privateKeyPassword,
                                                                             T... certificateChain)

withIdentityMaterial

@SafeVarargs
public final <T extends Certificate> SSLFactory.Builder withIdentityMaterial(Key privateKey,
                                                                             char[] privateKeyPassword,
                                                                             String alias,
                                                                             T... certificateChain)

withIdentityMaterial

public final <T extends Certificate> SSLFactory.Builder withIdentityMaterial(Key privateKey,
                                                                             char[] privateKeyPassword,
                                                                             List<T> certificateChain)

withIdentityMaterial

public final <T extends Certificate> SSLFactory.Builder withIdentityMaterial(Key privateKey,
                                                                             char[] privateKeyPassword,
                                                                             String alias,
                                                                             List<T> certificateChain)

withIdentityMaterial

public <T extends X509KeyManager> SSLFactory.Builder withIdentityMaterial(T keyManager)

withIdentityMaterial

public <T extends KeyManagerFactory> SSLFactory.Builder withIdentityMaterial(T keyManagerFactory)

withDummyIdentityMaterial

public SSLFactory.Builder withDummyIdentityMaterial()

withSwappableIdentityMaterial

public SSLFactory.Builder withSwappableIdentityMaterial()

Enables the possibility to swap the underlying KeyManager at runtime. After this option has been enabled the KeyManager can be swapped with KeyManagerUtils#swapKeyManager(swappableKeyManager, newKeyManager)

Returns:

SSLFactory.Builder

withLoggingIdentityMaterial

public SSLFactory.Builder withLoggingIdentityMaterial()

withInflatableTrustMaterial

public SSLFactory.Builder withInflatableTrustMaterial()

withInflatableTrustMaterial

@Deprecated
public SSLFactory.Builder withInflatableTrustMaterial(Path trustStorePath,
                                                      char[] trustStorePassword,
                                                      String trustStoreType,
                                                      BiPredicate<X509Certificate[],String> certificateAndAuthTypeTrustPredicate)

Deprecated.

withInflatableTrustMaterial

public SSLFactory.Builder withInflatableTrustMaterial(Path trustStorePath,
                                                      char[] trustStorePassword,
                                                      String trustStoreType,
                                                      Predicate<TrustManagerParameters> trustManagerParametersPredicate)

withIdentityRoute

public SSLFactory.Builder withIdentityRoute(String alias,
                                            String... hosts)

withIdentityRoute

public SSLFactory.Builder withIdentityRoute(Map<String,List<String>> aliasesToHosts)

withHostnameVerifier

public <T extends HostnameVerifier> SSLFactory.Builder withHostnameVerifier(T hostnameVerifier)

withUnsafeHostnameVerifier

public SSLFactory.Builder withUnsafeHostnameVerifier()

withHostnameVerifierEnhancer

public SSLFactory.Builder withHostnameVerifierEnhancer(Predicate<HostnameVerifierParameters> hostnameVerifierParametersValidator)

withCiphers

public SSLFactory.Builder withCiphers(String... ciphers)

withSystemPropertyDerivedCiphers

public SSLFactory.Builder withSystemPropertyDerivedCiphers()

withProtocols

public SSLFactory.Builder withProtocols(String... protocols)

withSystemPropertyDerivedProtocols

public SSLFactory.Builder withSystemPropertyDerivedProtocols()

withNeedClientAuthentication

public SSLFactory.Builder withNeedClientAuthentication()

withNeedClientAuthentication

public SSLFactory.Builder withNeedClientAuthentication(boolean needClientAuthentication)

withWantClientAuthentication

public SSLFactory.Builder withWantClientAuthentication()

withWantClientAuthentication

public SSLFactory.Builder withWantClientAuthentication(boolean wantClientAuthentication)

withSessionTimeout

public SSLFactory.Builder withSessionTimeout(int timeoutInSeconds)

withSessionCacheSize

public SSLFactory.Builder withSessionCacheSize(int cacheSizeInBytes)

withSslContextAlgorithm

public SSLFactory.Builder withSslContextAlgorithm(String sslContextAlgorithm)

withSecurityProvider

public <T extends Provider> SSLFactory.Builder withSecurityProvider(T securityProvider)

withSecurityProvider

public SSLFactory.Builder withSecurityProvider(String securityProviderName)

withSecureRandom

public <T extends SecureRandom> SSLFactory.Builder withSecureRandom(T secureRandom)

withTrustingAllCertificatesWithoutValidation

public SSLFactory.Builder withTrustingAllCertificatesWithoutValidation()

withTrustEnhancer

@Deprecated
public SSLFactory.Builder withTrustEnhancer(ChainAndAuthTypeValidator validator)

Deprecated.

withTrustEnhancer

@Deprecated
public SSLFactory.Builder withTrustEnhancer(ChainAndAuthTypeWithSocketValidator validator)

Deprecated.

withTrustEnhancer

@Deprecated
public SSLFactory.Builder withTrustEnhancer(ChainAndAuthTypeWithSSLEngineValidator validator)

Deprecated.

withTrustEnhancer

public SSLFactory.Builder withTrustEnhancer(Predicate<TrustManagerParameters> validator)

build

public SSLFactory build()