org.jenkinsci.plugins.database

Class PerItemDatabase

java.lang.Object

hudson.model.AbstractDescribableImpl<PerItemDatabase>

org.jenkinsci.plugins.database.PerItemDatabase

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<PerItemDatabase>

public abstract class PerItemDatabase
extends hudson.model.AbstractDescribableImpl<PerItemDatabase>
implements hudson.ExtensionPoint

Similar to Database but assumes that there is a separate database per item. Typically would be implemented by an embeddable database capable of loading from the root directory. It is recommended, but not required, that implementations have a no-argument DataBoundConstructor, which permits them to be configured by default merely by installing a plugin.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
PerItemDatabase()

Method Summary

Methods

Modifier and Type	Method and Description
abstract DataSource	getDataSource(hudson.model.TopLevelItem item) Loads the database for an item.
PerItemDatabaseDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Detail

PerItemDatabase

public PerItemDatabase()

Method Detail

getDataSource

public abstract DataSource getDataSource(hudson.model.TopLevelItem item)
                                  throws SQLException

Loads the database for an item. Should be created if not already present. Since multiple plugins may be sharing this database, prefix any table names with the plugin name.

Parameters:

item - a job, folder, etc.

Returns:

a database connection specific to that item

Throws:

SQLException - in case it is impossible to connect to the database

getDescriptor

public PerItemDatabaseDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<PerItemDatabase>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<PerItemDatabase>