Package org.jenkinsci.plugins.database

Class GlobalDatabaseConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.plugins.database.GlobalDatabaseConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Extension(ordinal=-33.0)
public class GlobalDatabaseConfiguration
extends GlobalConfiguration

Provides the system-wide Database that's open for plugins to store arbitrary information.

If a plugin wishes to store some information globally to RDBMS, and if the data can co-exist with the data from other plugins, use this shared database instance. In cases where a plugin wants to store data in its own database separate from this shared instance, you can do so by using Database directly.

There's also PerItemDatabaseConfiguration, which provides separate database for information local to a specific job.

Author:

Kohsuke Kawaguchi

See Also:

PerItemDatabaseConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
GlobalDatabaseConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
static GlobalDatabaseConfiguration	get()
Database	getDatabase()	This is the configured Database instance, or null in case none is configured yet.
void	setDatabase(Database database)

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalDatabaseConfiguration

public GlobalDatabaseConfiguration()

Method Detail

getDatabase

@CheckForNull
public Database getDatabase()

This is the configured Database instance, or null in case none is configured yet.

setDatabase

public void setDatabase(Database database)

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException

get

public static GlobalDatabaseConfiguration get()