ConnectionPropertiesTransform


1   /*
2    Copyright (C) 2002-2004 MySQL AB
3   
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of version 2 of the GNU General Public License as 
6    published by the Free Software Foundation.
7   
8    There are special exceptions to the terms and conditions of the GPL 
9    as it is applied to this software. View the full text of the 
10   exception in file EXCEPTIONS-CONNECTOR-J in the directory of this 
11   software distribution.
12  
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17  
18   You should have received a copy of the GNU General Public License
19   along with this program; if not, write to the Free Software
20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  
22   */
23  package com.mysql.jdbc;
24  
25  import java.sql.SQLException  ;
26  import java.util.Properties  ;
27  
28  /**
29   * Implement this interface, and pass the class name as the
30   * 'propertiesTransform' property in your JDBC URL, and the driver will pass the
31   * properties it has parsed to your transform implementation so that you can
32   * modify/substitute/add any that you desire.
33   * 
34   * @author Mark Matthews
35   * 
36   * @version $Id: ConnectionPropertiesTransform.java,v 1.1.2.1 2005/05/13
37   *          18:58:37 mmatthews Exp $
38   */
39  public interface ConnectionPropertiesTransform {
40      /**
41       * The JDBC driver will call this method if the user has loaded your
42       * implementation of this interface by specifying the 'propertiesTransform'
43       * property in their JDBC URL.
44       * 
45       * @param props
46       *            the properties as passed by the driver (never null)
47       * 
48       * @return the same properties with any transformations that your
49       *         implementation has made
50       * 
51       * @throws SQLException
52       *             if a transform can not be made for any reason.
53       */
54      public Properties   transformProperties(Properties   props) throws SQLException  ;
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags