ConnectionFactoryOptions (Reactive Relational Database Connectivity

java.lang.Object
- io.r2dbc.spi.ConnectionFactoryOptions

```
public final class ConnectionFactoryOptions
extends Object
```
A holder for configuration options related to ConnectionFactorys.
A ConnectionFactoryOptions represents a configuration state that consists of one or more Option objects. Each configuration option can be specified at most once to associate a value with its key.
New objects are constructed through builder() or by parsing a R2DBC Connection URL. ConnectionFactoryOptions can be augmented to allow staged construction of the configuration state using a initialized builder to create a new ConnectionFactoryOptions objects with mutations applied. Values of this class are immutable once created. Builder initializers are left unchanged.
Example usage:
```
 ConnectionFactoryOptions options = ConnectionFactoryOptions.builder()
     .option(ConnectionFactoryOptions.DRIVER, "a-driver")
     .option(ConnectionFactoryOptions.PROTOCOL, "pipes")
     .option(ConnectionFactoryOptions.HOST, "localhost")
     .option(ConnectionFactoryOptions.PORT, 3306)
     .option(ConnectionFactoryOptions.DATABASE, "my_database")
     .option(Option.valueOf("locale"), "en_US")
     .build();
 
```
Note that Connection URL Parsing cannot access Option type information T due to Java's type erasure. Options configured by URL parsing are represented as String values.
See Also:

ConnectionFactories

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConnectionFactoryOptions.Builder
A builder for ConnectionFactoryOptions instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnectionFactoryOptions.Builder` A builder for `ConnectionFactoryOptions` instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static Option<Duration>`	`CONNECT_TIMEOUT` Connection timeout.
`static Option<String>`	`DATABASE` Initial database name.
`static Option<String>`	`DRIVER` Driver name.
`static Option<String>`	`HOST` Endpoint host name.
`static Option<Duration>`	`LOCK_WAIT_TIMEOUT` Lock timeout.
`static Option<CharSequence>`	`PASSWORD` Password for authentication.
`static Option<Integer>`	`PORT` Endpoint port number.
`static Option<String>`	`PROTOCOL` Driver protocol name.
`static Option<Boolean>`	`SSL` Whether to require SSL.
`static Option<Duration>`	`STATEMENT_TIMEOUT` Statement timeout.
`static Option<String>`	`USER` User for authentication.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConnectionFactoryOptions.Builder`	`builder()` Returns a new `ConnectionFactoryOptions.Builder`.
`boolean`	`equals(Object o)`
`Object`	`getRequiredValue(Option<?> option)` Returns the value for an option if it exists.
`Object`	`getValue(Option<?> option)` Returns the value for an option if it exists, otherwise `null`.
`int`	`hashCode()`
`boolean`	`hasOption(Option<?> option)` Returns `true` if the option exists, otherwise `false`.
`ConnectionFactoryOptions.Builder`	`mutate()` Returns a new `ConnectionFactoryOptions.Builder` initialized with this `ConnectionFactoryOptions`.
`static ConnectionFactoryOptions`	`parse(CharSequence url)` Parses a R2DBC Connection URL and returns the parsed `ConnectionFactoryOptions`.
`String`	`toString()`

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

- Field Detail
  - CONNECT_TIMEOUT
```
public static final Option<Duration> CONNECT_TIMEOUT
```
    Connection timeout.
  - DATABASE
```
public static final Option<String> DATABASE
```
    Initial database name.
  - DRIVER
```
public static final Option<String> DRIVER
```
    Driver name.
  - HOST
```
public static final Option<String> HOST
```
    Endpoint host name.
  - LOCK_WAIT_TIMEOUT
```
public static final Option<Duration> LOCK_WAIT_TIMEOUT
```
    Lock timeout.
    
    Since:
    
    0.9
  - PASSWORD
```
public static final Option<CharSequence> PASSWORD
```
    Password for authentication.
  - PORT
```
public static final Option<Integer> PORT
```
    Endpoint port number.
  - PROTOCOL
```
public static final Option<String> PROTOCOL
```
    Driver protocol name. Typically represented as tcp or a database vendor-specific protocol string.
  - SSL
```
public static final Option<Boolean> SSL
```
    Whether to require SSL.
  - STATEMENT_TIMEOUT
```
public static final Option<Duration> STATEMENT_TIMEOUT
```
    Statement timeout.
    
    Since:
    
    0.9
  - USER
```
public static final Option<String> USER
```
    User for authentication.
- Method Detail
  - builder
```
public static ConnectionFactoryOptions.Builder builder()
```
    Returns a new ConnectionFactoryOptions.Builder.
    
    Returns:
    
    a new ConnectionFactoryOptions.Builder
  - parse
```
public static ConnectionFactoryOptions parse(CharSequence url)
```
    Parses a R2DBC Connection URL and returns the parsed ConnectionFactoryOptions. URL format: r2dbc:driver[:protocol]://[user:password@]host[:port][/path][?option=value]}.
    
    Parameters:
    
    url - the R2DBC URL.
    
    Returns:
    
    the parsed ConnectionFactoryOptions.
  - mutate
```
public ConnectionFactoryOptions.Builder mutate()
```
    Returns a new ConnectionFactoryOptions.Builder initialized with this ConnectionFactoryOptions.
    
    Returns:
    
    a new ConnectionFactoryOptions.Builder
  - getRequiredValue
```
public Object getRequiredValue(Option<?> option)
```
    Returns the value for an option if it exists.
    
    Parameters:
    
    option - the option to retrieve the value for
    
    Returns:
    
    the value for an option
    
    Throws:
    
    IllegalArgumentException - if option is null
    
    NoSuchOptionException - if option is not configured or there is no value for option
  - getValue
```
@Nullable
public Object getValue(Option<?> option)
```
    Returns the value for an option if it exists, otherwise null.
    
    Parameters:
    
    option - the option to retrieve the value for
    
    Returns:
    
    the value for an option if it exists, otherwise null
    
    Throws:
    
    IllegalArgumentException - if option is null
  - hasOption
```
public boolean hasOption(Option<?> option)
```
    Returns true if the option exists, otherwise false.
    
    Parameters:
    
    option - the option to test for
    
    Returns:
    
    true if the option exists, otherwise false
    
    Throws:
    
    IllegalArgumentException - if option is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ConnectionFactoryOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECT_TIMEOUT

DATABASE

DRIVER

HOST

LOCK_WAIT_TIMEOUT

PASSWORD

PORT

PROTOCOL

SSL

STATEMENT_TIMEOUT

USER

Method Detail

builder

parse

mutate

getRequiredValue

getValue

hasOption

toString

equals

hashCode