wamblee.org Git - utils/blob - support/general/src/test/java/org/wamblee/persistence/Database.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.persistence;
  17
  18 import java.sql.Connection;
  19 import java.sql.SQLException;
  20
  21 /**
  22  * Represents a database.
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public interface Database {
  27     /**
  28      * Starts a database. This call should not block and return as soon as the
  29      * database has been started.
  30      */
  31     void start();
  32
  33     /**
  34      * Gets the Jdbc Url to connect to this database.
  35      *
  36      * @return Jdbc Url.
  37      */
  38     String getJdbcUrl();
  39
  40     /**
  41      * Gets the external Jdbc URL to connect to this database from other JVMs.
  42      */
  43     String getExternalJdbcUrl();
  44
  45     /**
  46      * Gets the driver class name used to connect to the database from another
  47      * JVM.
  48      *
  49      * @return Driver class name.
  50      */
  51     String getDriverClassName();
  52
  53     /**
  54      * Gets the username to connect to the database.
  55      *
  56      * @return username.
  57      */
  58     String getUsername();
  59
  60     /**
  61      * Gets the password to connect to the database.
  62      *
  63      * @return password.
  64      */
  65     String getPassword();
  66
  67     /**
  68      * Creates a new database connection. It is the caller's responsibility to
  69      * close this connection.
  70      *
  71      * @return Newly created database connection.
  72      */
  73     Connection createConnection() throws SQLException;
  74
  75     /**
  76      * Stops a database.
  77      */
  78     void stop();
  79 }