summaryrefslogtreecommitdiffstats
path: root/sandbox/old/contrib/persistence/datasource/src/main/java/org/apache/tuscany/persistence/datasource/DataSourceProvider.java
blob: d29089be6daefc6f03040c378f973dca8ded1e1c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.tuscany.persistence.datasource;

import javax.sql.DataSource;

/**
 * DataSource providers may optionally implement this interface to receive callback notifications
 *
 * @version $Rev$ $Date$
 */
public interface DataSourceProvider {

    /**
     * Signals to the provider to initialize after all parameters have been set
     *
     * @throws ProviderException if an exception occurs during initialization
     */
    void init() throws ProviderException;

    /**
     * Signals to the provider to close any open resources and prepare for shutdown
     *
     * @throws ProviderException if an exception occurs during shutdown
     */
    void close() throws ProviderException;

    /**
     * Returns a new <code>DataSource</code> instance that will be bound into a composite system service tree. Called
     * after initialize.
     *
     * @throws ProviderException if an error occurs creating a new instance
     */
    DataSource getDataSource() throws ProviderException;

}