org.davidmoten.rx.jdbc

Interface ConnectionProvider

All Known Implementing Classes:

SingletonConnectionProvider

public interface ConnectionProvider

Provides JDBC Connections as required. It is advisable generally to use a Connection pool.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection provider and releases its resources.
static ConnectionProvider	from(java.sql.Connection connection) Warning: Don't pass one of these as a ConnectionProvider to a pool because once the pool closes the connection the pool cannot create a new one (the same closed connection is returned).
static ConnectionProvider	from(java.lang.String url)
static ConnectionProvider	from(java.lang.String url, java.util.Properties properties)
static ConnectionProvider	from(java.lang.String url, java.lang.String username, java.lang.String password)
java.sql.Connection	get() Returns a new Connection (perhaps from a Connection pool).

Method Detail

get

@Nonnull
java.sql.Connection get()

Returns a new Connection (perhaps from a Connection pool).

Returns:

a new Connection to a database

close

void close()

Closes the connection provider and releases its resources. For example, a connection pool may need formal closure to release its connections because connection.close() is actually just releasing a connection back to the pool for reuse. This method should be idempotent.

from

static ConnectionProvider from(@Nonnull
                               java.sql.Connection connection)

Warning: Don't pass one of these as a ConnectionProvider to a pool because once the pool closes the connection the pool cannot create a new one (the same closed connection is returned). Instead use a different ConnectionProvider factory method.

Parameters:

connection - connection for singleton provider

Returns:

singleton connection provider (don't use with connection pools!)

from

static ConnectionProvider from(@Nonnull
                               java.lang.String url)

from

static ConnectionProvider from(@Nonnull
                               java.lang.String url,
                               java.lang.String username,
                               java.lang.String password)

from

static ConnectionProvider from(@Nonnull
                               java.lang.String url,
                               java.util.Properties properties)