TlsContextFactoryBuilder (Mule API 1.2.0-20210120 API)

```
@NoImplement
public interface TlsContextFactoryBuilder
```
Builder for TlsContextFactory. To configure a trust store, at least it's path and password must be provided. To configure a key store, at least it's path, password and key password must be provided.

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TlsContextFactory`	`build()` Returns a `TlsContextFactory` based on the configured properties.
`TlsContextFactory`	`buildDefault()`
`TlsContextFactoryBuilder`	`enabledCipherSuites(String cipherSuites)` Defines the enabled TLS cipher suites, which must be a subset of the global enabled ones, otherwise a `CreateException` will occur upon `build()`.
`TlsContextFactoryBuilder`	`enabledProtocols(String protocols)` Defines the enabled TLS protocols, which must be a subset of the global enabled ones, otherwise a `CreateException` will occur upon `build()`.
`TlsContextFactoryBuilder`	`insecureTrustStore(boolean insecure)` Defines whether the trust store should be insecure, meaning no certificate validations should be performed.
`TlsContextFactoryBuilder`	`keyAlias(String alias)` Defines the alias of the key to use when the key store contains many private keys.
`TlsContextFactoryBuilder`	`keyPassword(String password)` Defines the password used to protect the private key.
`TlsContextFactoryBuilder`	`keyStoreAlgorithm(String algorithm)` Defines the key store algorithm.
`TlsContextFactoryBuilder`	`keyStorePassword(String password)` Defines the password to access the key store defined in `keyStorePath(String)`.
`TlsContextFactoryBuilder`	`keyStorePath(String path)` Defines the location (which will be resolved relative to the current classpath and file system, if possible) where the key store to use should be looked for.
`TlsContextFactoryBuilder`	`keyStoreType(String type)` Defines the type of the key store (such as jks, jceks or pkcs12).
`TlsContextFactoryBuilder`	`name(String name)` Defines a name for the `TlsContextFactory`.
`TlsRevocationCheckBuilder`	`revocationCheck()` Defines the certificate revocation checking mechanism.
`TlsContextFactoryBuilder`	`trustStoreAlgorithm(String algorithm)` Defines the trust store algorithm.
`TlsContextFactoryBuilder`	`trustStorePassword(String password)` Defines the password to access the trust store defined in `trustStorePath(String)`.
`TlsContextFactoryBuilder`	`trustStorePath(String path)` Defines the location (which will be resolved relative to the current classpath and file system, if possible) where the trust store to use should be looked for, requires `trustStorePassword(String)` too.
`TlsContextFactoryBuilder`	`trustStoreType(String type)` Defines the type of the trust store (such as jks, jceks or pkcs12).

- Method Detail
  - buildDefault
```
TlsContextFactory buildDefault()
```
    Returns:
    
    a TlsContextFactory with the jvm default certificates.
  - name
```
TlsContextFactoryBuilder name(String name)
```
    Defines a name for the TlsContextFactory. Recommended for troubleshooting purposes.
    
    Parameters:
    
    name - the name of the context
    
    Returns:
    
    this builder
  - enabledProtocols
```
TlsContextFactoryBuilder enabledProtocols(String protocols)
```
    Defines the enabled TLS protocols, which must be a subset of the global enabled ones, otherwise a CreateException will occur upon build(). By default, those global ones will be used.
    
    Parameters:
    
    protocols - a comma separated String with the protocols, for example "TLSv1.1,TLSv1.2"
    
    Returns:
    
    this builder
  - enabledCipherSuites
```
TlsContextFactoryBuilder enabledCipherSuites(String cipherSuites)
```
    Defines the enabled TLS cipher suites, which must be a subset of the global enabled ones, otherwise a CreateException will occur upon build(). By default, those global ones will be used.
    
    Parameters:
    
    cipherSuites - a comma separated String with the cipher suites, for example "TLS_DHE_DSS_WITH_AES_128_CBC_SHA,TLS_DHE_DSS_WITH_AES_256_CBC_SHA".
    
    Returns:
    
    this builder
  - trustStorePath
```
TlsContextFactoryBuilder trustStorePath(String path)
```
    Defines the location (which will be resolved relative to the current classpath and file system, if possible) where the trust store to use should be looked for, requires trustStorePassword(String) too.
    
    Parameters:
    
    path - the file path to the trust store
    
    Returns:
    
    this builder
  - trustStorePassword
```
TlsContextFactoryBuilder trustStorePassword(String password)
```
    Defines the password to access the trust store defined in trustStorePath(String).
    
    Parameters:
    
    password - the password
    
    Returns:
    
    this builder
  - trustStoreType
```
TlsContextFactoryBuilder trustStoreType(String type)
```
    Defines the type of the trust store (such as jks, jceks or pkcs12). By default, KeyStore.getDefaultType() will be used.
    
    Parameters:
    
    type -
    
    Returns:
    
    this builder
  - insecureTrustStore
```
TlsContextFactoryBuilder insecureTrustStore(boolean insecure)
```
    Defines whether the trust store should be insecure, meaning no certificate validations should be performed. Default value is false.
    
    Parameters:
    
    insecure -
    
    Returns:
    
    this builder
  - trustStoreAlgorithm
```
TlsContextFactoryBuilder trustStoreAlgorithm(String algorithm)
```
    Defines the trust store algorithm. By default, KeyManagerFactory.getDefaultAlgorithm() will be used.
    
    Parameters:
    
    algorithm - the algorithm to use
    
    Returns:
    
    this builder
  - keyStorePath
```
TlsContextFactoryBuilder keyStorePath(String path)
```
    Defines the location (which will be resolved relative to the current classpath and file system, if possible) where the key store to use should be looked for. Requires keyStorePassword(String) too.
    
    Parameters:
    
    path - the file path to the key store
    
    Returns:
    
    this builder
  - keyStorePassword
```
TlsContextFactoryBuilder keyStorePassword(String password)
```
    Defines the password to access the key store defined in keyStorePath(String).
    
    Parameters:
    
    password - the password used to protect the key store
    
    Returns:
    
    this builder
  - keyAlias
```
TlsContextFactoryBuilder keyAlias(String alias)
```
    Defines the alias of the key to use when the key store contains many private keys. By default, the first key in the file will be used.
    
    Parameters:
    
    alias - the alias of the key
    
    Returns:
    
    this builder
  - keyPassword
```
TlsContextFactoryBuilder keyPassword(String password)
```
    Defines the password used to protect the private key.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    this builder
  - keyStoreType
```
TlsContextFactoryBuilder keyStoreType(String type)
```
    Defines the type of the key store (such as jks, jceks or pkcs12). By default, KeyStore.getDefaultType() will be used.
    
    Parameters:
    
    type -
    
    Returns:
    
    this builder
  - keyStoreAlgorithm
```
TlsContextFactoryBuilder keyStoreAlgorithm(String algorithm)
```
    Defines the key store algorithm. By default, KeyManagerFactory.getDefaultAlgorithm() will be used.
    
    Parameters:
    
    algorithm -
    
    Returns:
    
    this builder
  - revocationCheck
```
TlsRevocationCheckBuilder revocationCheck()
```
    Defines the certificate revocation checking mechanism. By default no mechanism is selected.
    
    Returns:
    
    a revocation check builder
  - build
```
TlsContextFactory build()
                 throws CreateException
```
    Returns a TlsContextFactory based on the configured properties.
    
    Returns:
    
    a newly built TlsContextFactory.
    
    Throws:
    
    CreateException - if there's any trouble regarding protocols and cipher validation or store loading (such as the files not being found)

Interface TlsContextFactoryBuilder

Method Summary

Method Detail

buildDefault

name

enabledProtocols

enabledCipherSuites

trustStorePath

trustStorePassword

trustStoreType

insecureTrustStore

trustStoreAlgorithm

keyStorePath

keyStorePassword

keyAlias

keyPassword

keyStoreType

keyStoreAlgorithm

revocationCheck

build