MssqlConnectionConfiguration.Builder (Reactive Relational Database Connectivity

java.lang.Object
- io.r2dbc.mssql.MssqlConnectionConfiguration.Builder

Enclosing class:

MssqlConnectionConfiguration
```
public static final class MssqlConnectionConfiguration.Builder
extends Object
```
A builder for MssqlConnectionConfiguration instances.
This class is not threadsafe

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MssqlConnectionConfiguration.Builder`	`applicationName(String applicationName)` Configure the applicationName.
`MssqlConnectionConfiguration`	`build()` Returns a configured `MssqlConnectionConfiguration`.
`MssqlConnectionConfiguration.Builder`	`connectionId(UUID connectionId)` Configure the connectionId.
`MssqlConnectionConfiguration.Builder`	`connectTimeout(Duration connectTimeout)` Configure the connect timeout.
`MssqlConnectionConfiguration.Builder`	`database(String database)` Configure the database.
`MssqlConnectionConfiguration.Builder`	`enableSsl()` Enable SSL usage.
`MssqlConnectionConfiguration.Builder`	`enableSslTunnel()` Enable SSL tunnel usage to encrypt all traffic right from the connect phase.
`MssqlConnectionConfiguration.Builder`	`enableSslTunnel(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> sslTunnelSslContextBuilderCustomizer)` Enable SSL tunnel usage to encrypt all traffic right from the connect phase.
`MssqlConnectionConfiguration.Builder`	`host(String host)` Configure the host.
`MssqlConnectionConfiguration.Builder`	`hostNameInCertificate(String hostNameInCertificate)` Configure the expected hostname in the SSL certificate.
`MssqlConnectionConfiguration.Builder`	`lockWaitTimeout(Duration timeout)` Configure the lock wait timeout via `SET LOCK_TIMEOUT`.
`MssqlConnectionConfiguration.Builder`	`password(CharSequence password)` Configure the password.
`MssqlConnectionConfiguration.Builder`	`port(int port)` Configure the port.
`MssqlConnectionConfiguration.Builder`	`preferCursoredExecution(boolean preferCursoredExecution)` Configure whether to prefer cursored execution.
`MssqlConnectionConfiguration.Builder`	`preferCursoredExecution(Predicate<String> preference)` Configure whether to prefer cursored execution on a statement-by-statement basis.
`MssqlConnectionConfiguration.Builder`	`sendStringParametersAsUnicode(boolean sendStringParametersAsUnicode)` Configure whether to send character data as unicode (NVARCHAR, NCHAR, NTEXT) or whether to use the database encoding.
`MssqlConnectionConfiguration.Builder`	`sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> sslContextBuilderCustomizer)` Configure a `SslContextBuilder` customizer.
`MssqlConnectionConfiguration.Builder`	`tcpKeepAlive(boolean enabled)` Configure TCP KeepAlive.
`MssqlConnectionConfiguration.Builder`	`tcpNoDelay(boolean enabled)` Configure TCP NoDelay.
`MssqlConnectionConfiguration.Builder`	`trustServerCertificate()` Allow using SSL by fully trusting the server certificate.
`MssqlConnectionConfiguration.Builder`	`trustServerCertificate(boolean trustServerCertificate)` Allow using SSL by fully trusting the server certificate.
`MssqlConnectionConfiguration.Builder`	`trustStore(File trustStore)` Configure the path to the trust store.
`MssqlConnectionConfiguration.Builder`	`trustStore(String trustStoreFile)` Configure the file path to the trust store.
`MssqlConnectionConfiguration.Builder`	`trustStorePassword(char[] trustStorePassword)` Configure the password to read the trust store.
`MssqlConnectionConfiguration.Builder`	`trustStoreType(String trustStoreType)` Configure the trust store type.
`MssqlConnectionConfiguration.Builder`	`username(String username)` Configure the username.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - applicationName
```
public MssqlConnectionConfiguration.Builder applicationName(String applicationName)
```
    Configure the applicationName.
    
    Parameters:
    
    applicationName - the applicationName
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if applicationName is null
  - connectionId
```
public MssqlConnectionConfiguration.Builder connectionId(UUID connectionId)
```
    Configure the connectionId.
    
    Parameters:
    
    connectionId - the application name
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - when UUID is null.
  - connectTimeout
```
public MssqlConnectionConfiguration.Builder connectTimeout(Duration connectTimeout)
```
    Configure the connect timeout. Defaults to 30 seconds.
    
    Parameters:
    
    connectTimeout - the connect timeout
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
  - database
```
public MssqlConnectionConfiguration.Builder database(@Nullable
                                                     String database)
```
    Configure the database.
    
    Parameters:
    
    database - the database
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
  - enableSsl
```
public MssqlConnectionConfiguration.Builder enableSsl()
```
    Enable SSL usage. This flag is also known as Use Encryption in other drivers.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
  - enableSslTunnel
```
public MssqlConnectionConfiguration.Builder enableSslTunnel()
```
    Enable SSL tunnel usage to encrypt all traffic right from the connect phase. This option is required when using a SSL tunnel (e.g. stunnel or other SSL terminator) in front of the SQL server and it is not related to SQL Server's built-in SSL support.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Since:
    
    0.8.5
  - enableSslTunnel
```
public MssqlConnectionConfiguration.Builder enableSslTunnel(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> sslTunnelSslContextBuilderCustomizer)
```
    Enable SSL tunnel usage to encrypt all traffic right from the connect phase. This option is required when using a SSL tunnel (e.g. stunnel or other SSL terminator) in front of the SQL server and it is not related to SQL Server's built-in SSL support. The given customizer gets applied on each SSL connection attempt to allow for just-in-time configuration updates. The Function gets * called with the prepared SslContextBuilder that has all configuration options applied. The customizer may return the same builder or return a new builder instance to be used to * build the SSL context.
    
    Parameters:
    
    sslTunnelSslContextBuilderCustomizer - customizer function
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if sslTunnelSslContextBuilderCustomizer is null
    
    Since:
    
    0.8.5
  - host
```
public MssqlConnectionConfiguration.Builder host(String host)
```
    Configure the host.
    
    Parameters:
    
    host - the host
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if host is null
  - hostNameInCertificate
```
public MssqlConnectionConfiguration.Builder hostNameInCertificate(String hostNameInCertificate)
```
    Configure the expected hostname in the SSL certificate. Defaults to host(String) if left unconfigured. Accepts wildcards such as *.database.windows.net.
    
    Parameters:
    
    hostNameInCertificate - the hostNameInCertificate
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if hostNameInCertificate is null
  - lockWaitTimeout
```
public MssqlConnectionConfiguration.Builder lockWaitTimeout(Duration timeout)
```
    Configure the lock wait timeout via SET LOCK_TIMEOUT. Negative values are translated to -1 meaning infinite wait.
    
    Parameters:
    
    timeout - the lock wait timeout
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Since:
    
    0.9
  - password
```
public MssqlConnectionConfiguration.Builder password(CharSequence password)
```
    Configure the password.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if password is null
  - preferCursoredExecution
```
public MssqlConnectionConfiguration.Builder preferCursoredExecution(boolean preferCursoredExecution)
```
    Configure whether to prefer cursored execution.
    
    Parameters:
    
    preferCursoredExecution - true prefers cursors, false prefers direct execution. Defaults to direct execution.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if password is null
  - preferCursoredExecution
```
public MssqlConnectionConfiguration.Builder preferCursoredExecution(Predicate<String> preference)
```
    Configure whether to prefer cursored execution on a statement-by-statement basis. The Predicate accepts the SQL query string and returns a boolean flag indicating preference. true prefers cursors, false prefers direct execution. Defaults to direct execution.
    
    Parameters:
    
    preference - the Predicate.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if password is null
  - port
```
public MssqlConnectionConfiguration.Builder port(int port)
```
    Configure the port. Defaults to 5432.
    
    Parameters:
    
    port - the port
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
  - sendStringParametersAsUnicode
```
public MssqlConnectionConfiguration.Builder sendStringParametersAsUnicode(boolean sendStringParametersAsUnicode)
```
    Configure whether to send character data as unicode (NVARCHAR, NCHAR, NTEXT) or whether to use the database encoding. Enabled by default. If disabled, CharSequence data is sent using the database-specific collation such as ASCII/MBCS instead of Unicode.
    
    Parameters:
    
    sendStringParametersAsUnicode - true to send character data as unicode (NVARCHAR, NCHAR, NTEXT) or whether to use the database encoding. Enabled by default.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
  - sslContextBuilderCustomizer
```
public MssqlConnectionConfiguration.Builder sslContextBuilderCustomizer(Function<io.netty.handler.ssl.SslContextBuilder,io.netty.handler.ssl.SslContextBuilder> sslContextBuilderCustomizer)
```
    Configure a SslContextBuilder customizer. The customizer gets applied on each SSL connection attempt to allow for just-in-time configuration updates. The Function gets called with the prepared SslContextBuilder that has all configuration options applied. The customizer may return the same builder or return a new builder instance to be used to build the SSL context.
    
    Parameters:
    
    sslContextBuilderCustomizer - customizer function
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if sslContextBuilderCustomizer is null
    
    Since:
    
    0.8.3
  - tcpKeepAlive
```
public MssqlConnectionConfiguration.Builder tcpKeepAlive(boolean enabled)
```
    Configure TCP KeepAlive. Disabled by default.
    
    Parameters:
    
    enabled - whether to enable/disable TCP KeepAlive
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Since:
    
    0.8.5
    
    See Also:
    
    Socket.setKeepAlive(boolean)
  - tcpNoDelay
```
public MssqlConnectionConfiguration.Builder tcpNoDelay(boolean enabled)
```
    Configure TCP NoDelay. Enabled by default.
    
    Parameters:
    
    enabled - whether to enable/disable TCP NoDelay
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Since:
    
    0.8.5
    
    See Also:
    
    Socket.setTcpNoDelay(boolean)
  - trustServerCertificate
```
public MssqlConnectionConfiguration.Builder trustServerCertificate()
```
    Allow using SSL by fully trusting the server certificate. Enabling this option skips certificate verification.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder.
    
    Since:
    
    0.8.6
    
    See Also:
    
    TrustAllTrustManager
  - trustServerCertificate
```
public MssqlConnectionConfiguration.Builder trustServerCertificate(boolean trustServerCertificate)
```
    Allow using SSL by fully trusting the server certificate. Enabling this option skips certificate verification.
    
    Parameters:
    
    trustServerCertificate - true to trust the server certificate without further validation.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder.
    
    Since:
    
    0.8.6
    
    See Also:
    
    TrustAllTrustManager
  - trustStoreType
```
public MssqlConnectionConfiguration.Builder trustStoreType(String trustStoreType)
```
    Configure the trust store type.
    
    Parameters:
    
    trustStoreType - the type of the trust store to be used for SSL certificate verification. Defaults to KeyStore.getDefaultType() if not set.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if trustStoreType is null
    
    Since:
    
    0.8.3
  - trustStore
```
public MssqlConnectionConfiguration.Builder trustStore(String trustStoreFile)
```
    Configure the file path to the trust store.
    
    Parameters:
    
    trustStoreFile - the path of the trust store to be used for SSL certificate verification.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if trustStore is null
    
    Since:
    
    0.8.3
  - trustStore
```
public MssqlConnectionConfiguration.Builder trustStore(File trustStore)
```
    Configure the path to the trust store.
    
    Parameters:
    
    trustStore - the path of the trust store to be used for SSL certificate verification.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if trustStore is null
    
    Since:
    
    0.8.3
  - trustStorePassword
```
public MssqlConnectionConfiguration.Builder trustStorePassword(char[] trustStorePassword)
```
    Configure the password to read the trust store.
    
    Parameters:
    
    trustStorePassword - the password to read the trust store.
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Since:
    
    0.8.3
  - username
```
public MssqlConnectionConfiguration.Builder username(String username)
```
    Configure the username.
    
    Parameters:
    
    username - the username
    
    Returns:
    
    this MssqlConnectionConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if username is null
  - build
```
public MssqlConnectionConfiguration build()
```
    Returns a configured MssqlConnectionConfiguration.
    
    Returns:
    
    a configured MssqlConnectionConfiguration.

Class MssqlConnectionConfiguration.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

applicationName

connectionId

connectTimeout

database

enableSsl

enableSslTunnel

enableSslTunnel

host

hostNameInCertificate

lockWaitTimeout

password

preferCursoredExecution

preferCursoredExecution

port

sendStringParametersAsUnicode

sslContextBuilderCustomizer

tcpKeepAlive

tcpNoDelay

trustServerCertificate

trustServerCertificate

trustStoreType

trustStore

trustStore

trustStorePassword

username

build