org.rvpf.store.server.sql

Class StoreDataSource

Object

StoreDataSource

Direct Known Subclasses:

TheStoreDataSource

public abstract class StoreDataSource
extends Object

Store data source.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_PROPERTIES Custom properties.
static String	DRIVER_CLASS_PROPERTY The JDBC driver class.
static String	PASSWORD_PROPERTY The password for connection to the database.
static String	SHARED_PROPERTY Indicates that a single connection will be shared.
static String	URL_PROPERTY The URL for connection to the database.
static String	USER_PROPERTY The user for connection to the database.

Constructor Summary

Constructors

Constructor and Description
StoreDataSource()

Method Summary

Modifier and Type	Method and Description
StoreConnection	getConnection() Gets a connection.
protected abstract String	getDefaultConnectionOptions() Gets the default connection options.
protected abstract Optional<String>	getDefaultConnectionPassword() Gets the default connection password.
protected abstract boolean	getDefaultConnectionShared() Gets the default connection shared indicator.
protected abstract String	getDefaultConnectionURL(File storeDataDir, String storeEntityName) Gets the default connection URL.
protected abstract String	getDefaultConnectionUser() Gets the default connection user.
protected Logger	getThisLogger() Gets the logger.
protected StoreConnection	newStoreConnection(Connection connection, boolean shared) Creates a new store connection.
protected void	onFirstConnection(StoreConnection storeConnection) Called on the first connection.
protected abstract Class<? extends Driver>	registerDriver(ClassDef driverClassDef) Registers the JDBC driver.
boolean	setUp(KeyedGroups connectionProperties, File storeDataDir, String storeEntityName) Sets up the data source.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Field Detail

CUSTOM_PROPERTIES

public static final String CUSTOM_PROPERTIES

Custom properties.

See Also:

Constant Field Values

DRIVER_CLASS_PROPERTY

public static final String DRIVER_CLASS_PROPERTY

The JDBC driver class.

See Also:

Constant Field Values

PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY

The password for connection to the database.

See Also:

Constant Field Values

SHARED_PROPERTY

public static final String SHARED_PROPERTY

Indicates that a single connection will be shared. This is useful only for some JDBC drivers having problems with multiple connections to the same database.

See Also:

Constant Field Values

URL_PROPERTY

public static final String URL_PROPERTY

The URL for connection to the database.

See Also:

Constant Field Values

USER_PROPERTY

public static final String USER_PROPERTY

The user for connection to the database.

See Also:

Constant Field Values

Constructor Detail

StoreDataSource

public StoreDataSource()

Method Detail

getConnection

@Nonnull
 @CheckReturnValue
public StoreConnection getConnection()
                                                            throws SQLException

Gets a connection.

Returns:

The connection.

Throws:

SQLException - From the actual data source.

setUp

@CheckReturnValue
public final boolean setUp(@Nonnull
                                              KeyedGroups connectionProperties,
                                              @Nonnull
                                              File storeDataDir,
                                              @Nonnull
                                              String storeEntityName)

Sets up the data source.

Parameters:

connectionProperties - The connection properties.

storeDataDir - The store data directory.

storeEntityName - The store entity name.

Returns:

True on success.

tearDown

public final void tearDown()

Tears down what has been set up.

getDefaultConnectionOptions

@Nonnull
 @CheckReturnValue
protected abstract String getDefaultConnectionOptions()

Gets the default connection options.

Returns:

The default connection options.

getDefaultConnectionPassword

@Nonnull
 @CheckReturnValue
protected abstract Optional<String> getDefaultConnectionPassword()

Gets the default connection password.

Returns:

The optional default connection password.

getDefaultConnectionShared

@CheckReturnValue
protected abstract boolean getDefaultConnectionShared()

Gets the default connection shared indicator.

Returns:

The default connection shared indicator.

getDefaultConnectionURL

@Nonnull
protected abstract String getDefaultConnectionURL(@Nonnull
                                                            File storeDataDir,
                                                            @Nonnull
                                                            String storeEntityName)

Gets the default connection URL.

Parameters:

storeDataDir - The store data directory.

storeEntityName - The store entity name.

Returns:

The default connection URL.

getDefaultConnectionUser

@Nonnull
 @CheckReturnValue
protected abstract String getDefaultConnectionUser()

Gets the default connection user.

Returns:

The default connection user.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

newStoreConnection

@Nonnull
 @CheckReturnValue
protected StoreConnection newStoreConnection(@Nonnull
                                                                           Connection connection,
                                                                           boolean shared)

Creates a new store connection.

Parameters:

connection - The wrapped Connection.

shared - Specifies if the Connection is shared.

Returns:

A store connection.

onFirstConnection

protected void onFirstConnection(@Nonnull
                                 StoreConnection storeConnection)

Called on the first connection.

Parameters:

storeConnection - The newly established connection.

registerDriver

@Nullable
 @CheckReturnValue
protected abstract Class<? extends Driver> registerDriver(@Nonnull
                                                                                         ClassDef driverClassDef)

Registers the JDBC driver.

Parameters:

driverClassDef - The driver class definition.

Returns:

The driver class (null on failure).