(no commit message)
[utils] / test / enterprise / src / main / java / org / wamblee / test / persistence / Database.java
1 /*
2  * Copyright 2005-2010 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.test.persistence;
17
18 import javax.sql.DataSource;
19
20 /**
21  * Represents a database.
22  * 
23  * @author Erik Brakkee
24  */
25 public interface Database {
26
27     /**
28      * Starts a database. This call should not block and return as soon as the
29      * database has been started.
30      */
31     DataSource start();
32
33     /**
34      * Gets the number of active connections from the pool. This is useful for
35      * determining resource leaks.
36      * 
37      * @return Active connections.
38      */
39     int getActiveConnections();
40
41     /**
42      * Gets the Jdbc Url to connect to this database.
43      * 
44      * @return Jdbc Url.
45      */
46     String getJdbcUrl();
47
48     /**
49      * Gets the external Jdbc URL to connect to this database from other JVMs.
50      */
51     String getExternalJdbcUrl();
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      * Stops a database.
69      */
70     void stop();
71 }