public abstract class

DatabaseConfigPanel

extends Object
java.lang.Object
   ↳ com.atlassian.jira.configurator.db.DatabaseConfigPanel
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

An abstract class that represents the GUI Config panel for a particular DB type. Each DB type will require a separate subclass with DB-specific operations.

Summary

Constants
int TEXT_FIELD_COLUMNS
Public Constructors
DatabaseConfigPanel()
Public Methods
abstract String getClassName()
abstract String getDisplayName()
abstract JPanel getPanel()
abstract String getPassword()
abstract String getSchemaName()
For DB's that want to allow entity-engine to set a schema-name, this will return the user's selected Schema-name
abstract String getUrl(String jiraHome)
Returns the JDBC URL for this DB config.
abstract String getUsername()
void saveSettings(Settings newSettings, String jiraHome)
Apply the current user entered settings into the given Settings object.
abstract void setSettings(Settings settings)
void testConnection(String jiraHome)
String toString()
abstract void validate()
Verify that the settings are valid.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int TEXT_FIELD_COLUMNS

Constant Value: 20 (0x00000014)

Public Constructors

public DatabaseConfigPanel ()

Public Methods

public abstract String getClassName ()

public abstract String getDisplayName ()

public abstract JPanel getPanel ()

public abstract String getPassword ()

public abstract String getSchemaName ()

For DB's that want to allow entity-engine to set a schema-name, this will return the user's selected Schema-name

Returns
  • the user's selected Schema-name

public abstract String getUrl (String jiraHome)

Returns the JDBC URL for this DB config.

The current jira-home is passed because it used by H2.

Parameters
jiraHome The current configured jira-home
Returns
  • the JDBC URL for this DB config.
Throws
ValidationException If the underlying configuration is invalid for this DB type. eg for Postgres, "Database" (instance) is a required field

public abstract String getUsername ()

public void saveSettings (Settings newSettings, String jiraHome)

Apply the current user entered settings into the given Settings object.

Parameters
newSettings The Settings object to set the values in.
jiraHome the jira home where the settings should be saved
Throws
ValidationException if any of the new settings are Invalid

public abstract void setSettings (Settings settings)

Throws
ParseException

public void testConnection (String jiraHome)

Throws
ClassNotFoundException
SQLException
ValidationException

public String toString ()

public abstract void validate ()

Verify that the settings are valid.

Throws
ValidationException if any config is invalid.