001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package javax.sql;
023:
024: import java.io.PrintWriter;
025: import java.sql.SQLException;
026:
027: /**
028: * A ConnectionPoolDataSource object is a factory for PooledConnection objects. An object that implements this
029: * interface will typically be registered with a JNDI service.
030: */
031: public interface ConnectionPoolDataSource {
032:
033: /**
034: * <p>Get the log writer for this data source.</p>
035: *
036: * <p>The log writer is a character output stream to which all logging and tracing messages for this
037: * data source object instance will be printed. This includes messages printed by the methods of this object,
038: * messages printed by methods of other objects manufactured by this object, and so on. Messages printed to
039: * a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class.
040: * When a data source object is created the log writer is initially null, in other words, logging is disabled.</p>
041: *
042: * @return the log writer for this data source, null if disabled
043: * @exception SQLException - if a database-access error occurs.
044: */
045: public PrintWriter getLogWriter() throws SQLException;
046:
047: /**
048: * Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
049: * A value of zero means that the timeout is the default system timeout if there is one; otherwise it means that there
050: * is no timeout. When a data source object is created the login timeout is initially zero.
051: *
052: * @return the data source login time limit
053: * @exception SQLException - if a database access error occurs.
054: */
055: public int getLoginTimeout() throws SQLException;
056:
057: /**
058: * Attempt to establish a database connection.
059: *
060: * @return a Connection to the database
061: * @exception SQLException - if a database-access error occurs.
062: */
063: public PooledConnection getPooledConnection() throws SQLException;
064:
065: /**
066: * Attempt to establish a database connection.
067: *
068: * @param user - the database user on whose behalf the Connection is being made
069: * @param password - the user's password
070: * @return a Connection to the database
071: * @exception SQLException - if a database-access error occurs.
072: */
073: public PooledConnection getPooledConnection(String user,
074: String password) throws SQLException;
075:
076: /**
077: * <p>Set the log writer for this data source.</p>
078: *
079: * <p>The log writer is a character output stream to which all logging and tracing messages for this
080: * data source object instance will be printed. This includes messages printed by the methods of this object,
081: * messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a
082: * data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class.
083: * When a data source object is created the log writer is initially null, in other words, logging is disabled.</p>
084: *
085: * @param printWriter - the new log writer; to disable, set to null
086: * @exception SQLException - if a database-access error occurs.
087: */
088: public void setLogWriter(PrintWriter printWriter)
089: throws SQLException;
090:
091: /**
092: * Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
093: * A value of zero specifies that the timeout is the default system timeout if there is one; otherwise it
094: * specifies that there is no timeout. When a data source object is created the login timeout is initially zero.
095: *
096: * @param seconds - the data source login time limit
097: * @exception SQLException - if a database access error occurs.
098: */
099: public void setLoginTimeout(int seconds) throws SQLException;
100: }
|