org.opennms.core.utils

Class DBTools

java.lang.Object

org.opennms.core.utils.DBTools

public class DBTools
extends Object

This class is intended to be group some utility classes related with RDBMS and the capsd and monitoring plugins.

Since:

0.1

Version:

0.1 - 07/22/2002

Author:

Jose Vicente Nunez Zuleta (josevnz@users.sourceforge.net) - RHCE, SJCD, SJCP

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATABASE_PASSWORD Default database password.
static String	DEFAULT_DATABASE_USER Default user to use when connecting to the database.
static String	DEFAULT_JDBC_DRIVER Default Sybase JDBC driver to use.
static int	DEFAULT_PORT Default port to use to check this service.
static String	DEFAULT_URL Default vendor protocol, like jdbc:sybase:Tds:
static int	MAX_PORT_VALUE Maximum port range
static int	MIN_PORT_VALUE Minimal port range
static String	POSTGRESQL_JDBC_DRIVER PostgreSQL JDBC driver

Method Summary

Modifier and Type	Method and Description
static String	constructUrl(String url_, String hostname_) Constructs a JDBC url given a set of fragments.
static DBTools	getInstance() Returns a single instance of this class to the caller.
int	getNumberOfInstances() Return how many instances of this objects are loaded now

Methods inherited from class java.lang.Object

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

Field Detail

MIN_PORT_VALUE

public static final int MIN_PORT_VALUE

Minimal port range

See Also:

Constant Field Values

MAX_PORT_VALUE

public static final int MAX_PORT_VALUE

Maximum port range

See Also:

Constant Field Values

DEFAULT_JDBC_DRIVER

public static final String DEFAULT_JDBC_DRIVER

Default Sybase JDBC driver to use. Defaults to 'com.sybase.jdbc2.jdbc.SybDriver'

See Also:

Constant Field Values

POSTGRESQL_JDBC_DRIVER

public static final String POSTGRESQL_JDBC_DRIVER

PostgreSQL JDBC driver

See Also:

Constant Field Values

DEFAULT_DATABASE_USER

public static final String DEFAULT_DATABASE_USER

Default user to use when connecting to the database. Defaults to 'sa'

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

Default port to use to check this service. Defaults to '4100' Make sure than is less than MAX_PORT_VALUE and greater than MIN_PORT_VALUE

See Also:

MIN_PORT_VALUE, MAX_PORT_VALUE, Constant Field Values

DEFAULT_DATABASE_PASSWORD

public static final String DEFAULT_DATABASE_PASSWORD

Default database password. Should be empty. You should not put a database password here (or event worst, hardcode it in the code) Instead call the class method that accepts a map

See Also:

Constant Field Values

DEFAULT_URL

public static final String DEFAULT_URL

Default vendor protocol, like jdbc:sybase:Tds:

See Also:

Constant Field Values

Method Detail

getInstance

public static DBTools getInstance()

Returns a single instance of this class to the caller. We do not want multiple copies of this class loaded, just one.

Returns:

DBTools A class instance

getNumberOfInstances

public int getNumberOfInstances()

Return how many instances of this objects are loaded now

Returns:

int Number of instances on this JVM

constructUrl

public static String constructUrl(String url_,
                                  String hostname_)
                           throws IllegalArgumentException,
                                  NullPointerException

Constructs a JDBC url given a set of fragments. The resulting Url will have the form:
jdbc:<protocol>:hostname:4100

Parameters:

hostname_ - The hostname where the database server is

url_ - (for example jdbc:sybase:Tds:@{link #JDBC_HOST JDBC_HOST}:4100/tempdb). The JDBC_HOST is replaced by the real hostname

Returns:

a String object.

Throws:

NullPointerException - If one of the arguments is null

IllegalArgumentException - If the JDBC_HOST is not part of the JDBC url