KickJava   Java API By Example, From Geeks To Geeks.

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


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 /** The interface that every data source must implement.
26  * Classes implementing this interface can be instantiated
27  * either directly, or through the XMLDriverManager class.
28  */
29 public interface XMLDataSource {
30  
31
32
33   /** Attempts to establish a connection with the data source.
34    * @throws XMLDBCException If a data source access error occurs
35    * @return an XMLConnection object that represents a connection to the data source
36    */
37   public XMLConnection getConnection() throws XMLDBCException;
38   
39   /** Attempts to establish a connection with the data source.
40    * @param user the data source registered user
41    * @param password the user's password
42    * @throws XMLDBCException If a data source access error occurs
43    * @return an XMLConnection object that represents a connection to the data source
44    */
45   public XMLConnection getConnection(String JavaDoc user, String JavaDoc password) throws XMLDBCException;
46   
47   /** Sets the logging/tracing java.io.PrintWriter object that is used by the XDataSource object.
48    * @param writer the new logging/tracing java.io.PrintWriter object, or null to disable logging and tracing
49    */
50   public void setLogWriter(java.io.PrintWriter JavaDoc writer);
51   
52   /** Retrieves the log writer currently used by the XDataSource object to print messages.
53    * @return the java.io.PrintWriter object used to log data source messages, or null if none is defined
54    */
55   public java.io.PrintWriter JavaDoc getLogWriter();
56   
57   /** Sets the maximum time in seconds that the object will wait when attempting to log in to a data source. Setting the timeout to 0 will disable it.
58    * @param seconds the login time limit in seconds
59    */
60   public void setLoginTimeout(int seconds);
61   
62   /** Gets the maximum time in seconds that the object can wait when attempting to log in to a data source
63    * @return the data source login timeout in seconds, 0 if no timeout is defined
64    */
65   public int getLoginTimeout();
66   
67 }
68
69
Popular Tags