com.atlassian.refapp.api

Interface ConnectionProvider

All Known Implementing Classes:

ConnectionProviderImpl

public interface ConnectionProvider

Provides a database connection for use by core and plugins.

An H2 server (internal) database will be provided, unless the user specifies an external database via system properties:

refapp.jdbc.external set this to true to use an external database refapp.jdbc.driver.class.name Driver implementation to use refapp.jdbc.app.url mandatory jdbc url refapp.jdbc.app.schema optional jdbc schema - don't specify if you don't use a schema e.g. mysql, however must still be specified for all other databases; don't rely on the default schema refapp.jdbc.app.user mandatory jdbc user refapp.jdbc.app.pass mandatory jdbc password refapp.jdbc.app.val.query optional validation query for drivers that don't support Connection.isValid(int)

Method Summary

Modifier and Type	Method and Description
Connection	connection() Provides a connection from a pool.
DataSource	dataSource() Provides the DataSource used to source any database connections
String	driverClassName() Returns the configured database driver class name
Optional<String>	schema() Returns the configured schema name (if any)

Method Detail

connection

Connection connection()
               throws SQLException

Provides a connection from a pool.

Users may close the connection. Users may create transactions within the connection.

Returns:

valid connection

Throws:

SQLException - on any failure to provide connection

dataSource

DataSource dataSource()

Provides the DataSource used to source any database connections

Returns:

valid DataSource

Since:

3.2

schema

Optional<String> schema()

Returns the configured schema name (if any)

Returns:

schema name, if there is one

Since:

3.2

driverClassName

String driverClassName()

Returns the configured database driver class name

Returns:

fully qualified driver class name

Since:

3.2