org.ka2ddo.yaac.pluginapi

Class DbConnectionProvider

java.lang.Object

org.ka2ddo.yaac.pluginapi.Provider

org.ka2ddo.yaac.pluginapi.DbConnectionProvider

public abstract class DbConnectionProvider
extends Provider

This abstract superclass allows core YAAC code (and other plugins) to obtain a database Connection from a plugin whose Provider extends from this class.

Since:

PROVIDER_API_VERSION == 47

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.pluginapi.Provider

Provider.PortEntry

Field Summary

Fields inherited from class org.ka2ddo.yaac.pluginapi.Provider

PLUGIN_NEEDS_NEWER_YAAC_PROTOCOL, PLUGIN_UNKNOWN_INCOMPATIBILITY, PROVIDER_API_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DbConnectionProvider(java.lang.String name, java.lang.String version, java.lang.String author, java.lang.String info) Create a new plugin Provider specifying extensions to be added to YAAC.

Method Summary

Modifier and Type	Method and Description
abstract java.sql.Connection	getDbConnection() Get a database Connection to the configured database.
abstract java.lang.String	getDbURL() Get the JDBC URL String of the configured database.

Methods inherited from class org.ka2ddo.yaac.pluginapi.Provider

buildNewerYaacNeededMsg, consumeXMLPreferenceData, findHelpSet, getAboutAttributions, getAuthor, getConfigurationPanels, getFilters, getHelpSet, getImageIconPath, getInfo, getInitFailureReason, getMenuItems, getName, getPortConnectorTypes, getVersion, runInitializersAfter, runInitializersBefore

Methods inherited from class java.lang.Object

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

Constructor Detail

DbConnectionProvider

protected DbConnectionProvider(java.lang.String name,
                               java.lang.String version,
                               java.lang.String author,
                               java.lang.String info)

Create a new plugin Provider specifying extensions to be added to YAAC.

Parameters:

name - String human-displayed name for this plugin

version - String version identifier for this plugin

author - String name of author(s) of this plugin

info - String description of what services this plugin provides

Method Detail

getDbConnection

public abstract java.sql.Connection getDbConnection()

Get a database Connection to the configured database. Note the returned Connection (if any) is always configured not to auto-commit.

Returns:

Connection object, or null if DB is not configured

Since:

PROVIDER_API_VERSION == 47

getDbURL

public abstract java.lang.String getDbURL()

Get the JDBC URL String of the configured database.

Returns:

String of JDBC URL, or null if DB is not configured

Since:

PROVIDER_API_VERSION == 47