KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xml > xdbc > XMLDriver


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.xml.xdbc;
24
25 /**
26  * The interface that every driver class must implement.<BR><BR>
27  * It allows new connections from XMLDBC client.<BR><BR>
28  */
29 public interface XMLDriver {
30  
31     /**
32      * Returns true if the driver understand the specified connection string
33      * @param uri the connection string
34      * @return a boolean
35      * @throws XMLDBCException
36      */
37     public boolean acceptsURI(String JavaDoc uri) throws XMLDBCException;
38     
39     /**
40      * Returns the driver-specific part of the URI
41      * @param uri
42      * @return a string
43      * @throws XMLDBCException if the URI is not recognized by the driver
44      */
45     public String JavaDoc getSpecificPart(String JavaDoc uri) throws XMLDBCException;
46     
47     /**
48      * To obtain a handle to a data source with the specified URI.
49      * @param uri an URI corresponding to a data source.
50      * @return an instance of the specified data source,
51      * or null if the driver does not know this type of data source
52      * @throws XMLDBCException if a data source access error occurs.
53      */
54     public XMLDataSource getDataSource(String JavaDoc uri) throws XMLDBCException;
55
56     /**
57      * To obtain a handle to a data source with the specified URI, user name and password.
58      * @param uri a URI corresponding to a data source.
59      * @param user a user name
60      * @param password a user password
61      * @return an instance of the specified data source,
62      * or null if the driver does not know this type of data source
63      * @throws XMLDBCException if a data source access error occurs.
64      */
65     public XMLDataSource getDataSource(String JavaDoc uri, String JavaDoc user, String JavaDoc password) throws XMLDBCException;
66 }
67
Popular Tags