public interface

DatabaseConfigurationLoader

com.atlassian.jira.config.database.DatabaseConfigurationLoader
Known Indirect Subclasses

Class Overview

DatabaseConfigurationLoader is responsible for loading and persisting database configuration from and to the home directory.

Summary

Public Methods
boolean configExists()
Returns true only if the database configuration file already exists in the JIRA home directory.
DatabaseConfig loadDatabaseConfiguration()
Reads and deserialises the DatabaseConfig from its permanent store.
void saveDatabaseConfiguration(DatabaseConfig config)
Serialises and persists the given config to its permanent store.

Public Methods

public boolean configExists ()

Returns true only if the database configuration file already exists in the JIRA home directory.

Returns
  • whether the config file exists.

public DatabaseConfig loadDatabaseConfiguration ()

Reads and deserialises the DatabaseConfig from its permanent store.

Returns
  • the database configuration.
Throws
RuntimeIOException if the config cannot be loaded due to a missing file or bad permissions.
RuntimeException if the config cannot be loaded for example due to a corrupt file format.

public void saveDatabaseConfiguration (DatabaseConfig config)

Serialises and persists the given config to its permanent store.

Parameters
config the config to store.
Throws
RuntimeIOException if there was some IO problem saving.