io.vertx.sqlclient.impl

Class SqlConnectionFactoryBase

java.lang.Object

io.vertx.sqlclient.impl.SqlConnectionFactoryBase

All Implemented Interfaces:

Closeable, ConnectionFactory

Direct Known Subclasses:

DB2ConnectionFactory, MySQLConnectionFactory

public abstract class SqlConnectionFactoryBase
extends Object
implements ConnectionFactory

An abstract connection factory for creating database connections

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cachePreparedStatements
protected CloseFuture	clientCloseFuture
protected EventLoopContext	context
protected String	database
protected NetClient	netClient
protected String	password
protected int	preparedStatementCacheSize
protected Predicate<String>	preparedStatementCacheSqlFilter
protected Map<String,String>	properties
protected SocketAddress	socketAddress
protected String	username

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SqlConnectionFactoryBase(EventLoopContext context, SqlConnectOptions options)

Method Summary

Modifier and Type	Method and Description
void	close(Promise<Void> promise) Close this resource, the completion promise must be notified when the operation has completed.
protected abstract void	configureNetClientOptions(NetClientOptions netClientOptions) Apply the configuration to the NetClientOptions for connecting to the database.
void	connect(Promise<Connection> promise) Connect to the database and returns a connection.
protected abstract void	doConnectInternal(Promise<Connection> promise) Perform establishing connection to the server.
protected abstract void	initializeConfiguration(SqlConnectOptions options) Initialize the configuration after the common configuration have been initialized.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.sqlclient.impl.ConnectionFactory

asEventLoopContext

Field Detail

netClient

protected final NetClient netClient

context

protected final EventLoopContext context

socketAddress

protected final SocketAddress socketAddress

username

protected final String username

password

protected final String password

database

protected final String database

properties

protected final Map<String,String> properties

cachePreparedStatements

protected final boolean cachePreparedStatements

preparedStatementCacheSize

protected final int preparedStatementCacheSize

preparedStatementCacheSqlFilter

protected final Predicate<String> preparedStatementCacheSqlFilter

clientCloseFuture

protected final CloseFuture clientCloseFuture

Constructor Detail

SqlConnectionFactoryBase

protected SqlConnectionFactoryBase(EventLoopContext context,
                                   SqlConnectOptions options)

Method Detail

connect

public void connect(Promise<Connection> promise)

Description copied from interface: ConnectionFactory

Connect to the database and returns a connection.

Specified by:

connect in interface ConnectionFactory

close

public void close(Promise<Void> promise)

Description copied from interface: Closeable

Close this resource, the completion promise must be notified when the operation has completed.

Specified by:

close in interface Closeable

Specified by:

close in interface ConnectionFactory

Parameters:

promise - the promise to signal when close has completed

initializeConfiguration

protected abstract void initializeConfiguration(SqlConnectOptions options)

Initialize the configuration after the common configuration have been initialized.

Parameters:

options - the concrete options for initializing configuration by a specific connection factory.

configureNetClientOptions

protected abstract void configureNetClientOptions(NetClientOptions netClientOptions)

Apply the configuration to the NetClientOptions for connecting to the database.

Parameters:

netClientOptions - NetClient options to apply

doConnectInternal

protected abstract void doConnectInternal(Promise<Connection> promise)

Perform establishing connection to the server.

Parameters:

promise - the result handler