org.owasp.dependencycheck.data.nvdcve

Class ConnectionFactory

java.lang.Object

org.owasp.dependencycheck.data.nvdcve.ConnectionFactory

@ThreadSafe
public final class ConnectionFactory
extends Object

Loads the configured database driver and returns the database connection. If the embedded H2 database is used obtaining a connection will ensure the database file exists and that the appropriate table structure has been created.

Author:

Jeremy Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	DB_STRUCTURE_RESOURCE Resource location for SQL file used to create the database schema.
static String	DB_STRUCTURE_UPDATE_RESOURCE Resource location for SQL file used to create the database schema.
static String	UPGRADE_HELP_URL The URL that discusses upgrading non-H2 databases.

Constructor Summary

Constructors

Constructor and Description
ConnectionFactory(Settings settings) Private constructor for this factory class; no instance is ever needed.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleans up resources and unloads any registered database drivers.
Connection	getConnection() Constructs a new database connection object per the database configuration.
static File	getH2DataFile(Settings configuration) Returns a reference to the H2 database file.
boolean	h2DataFileExists() Determines if the H2 database file exists.
static boolean	h2DataFileExists(Settings configuration) Determines if the H2 database file exists.
void	initialize() Initializes the connection factory.
boolean	isH2Connection() Determines if the connection string is for an H2 database.
static boolean	isH2Connection(Settings configuration) Determines if the connection string is for an H2 database.

Methods inherited from class java.lang.Object

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

Field Detail

DB_STRUCTURE_RESOURCE

public static final String DB_STRUCTURE_RESOURCE

Resource location for SQL file used to create the database schema.

See Also:

Constant Field Values

DB_STRUCTURE_UPDATE_RESOURCE

public static final String DB_STRUCTURE_UPDATE_RESOURCE

Resource location for SQL file used to create the database schema.

See Also:

Constant Field Values

UPGRADE_HELP_URL

public static final String UPGRADE_HELP_URL

The URL that discusses upgrading non-H2 databases.

See Also:

Constant Field Values

Constructor Detail

ConnectionFactory

public ConnectionFactory(Settings settings)

Private constructor for this factory class; no instance is ever needed.

Parameters:

settings - the configured settings

Method Detail

initialize

public void initialize()
                throws DatabaseException

Initializes the connection factory. Ensuring that the appropriate drivers are loaded and that a connection can be made successfully.

Throws:

DatabaseException - thrown if we are unable to connect to the database

cleanup

public void cleanup()

Cleans up resources and unloads any registered database drivers. This needs to be called to ensure the driver is unregistered prior to the finalize method being called as during shutdown the class loader used to load the driver may be unloaded prior to the driver being de-registered.

getConnection

public Connection getConnection()
                         throws DatabaseException

Constructs a new database connection object per the database configuration.

Returns:

a database connection object

Throws:

DatabaseException - thrown if there is an exception loading the database connection

h2DataFileExists

public boolean h2DataFileExists()
                         throws IOException

Determines if the H2 database file exists. If it does not exist then the data structure will need to be created.

Returns:

true if the H2 database file does not exist; otherwise false

Throws:

IOException - thrown if the data directory does not exist and cannot be created

h2DataFileExists

public static boolean h2DataFileExists(Settings configuration)
                                throws IOException

Determines if the H2 database file exists. If it does not exist then the data structure will need to be created.

Parameters:

configuration - the configured settings

Returns:

true if the H2 database file does not exist; otherwise false

Throws:

IOException - thrown if the data directory does not exist and cannot be created

getH2DataFile

public static File getH2DataFile(Settings configuration)
                          throws IOException

Returns a reference to the H2 database file.

Parameters:

configuration - the configured settings

Returns:

the path to the H2 database file

Throws:

IOException - thrown if there is an error

isH2Connection

public boolean isH2Connection()

Determines if the connection string is for an H2 database.

Returns:

true if the connection string is for an H2 database

isH2Connection

public static boolean isH2Connection(Settings configuration)

Determines if the connection string is for an H2 database.

Parameters:

configuration - the configured settings

Returns:

true if the connection string is for an H2 database