StandaloneConnectionFactoryConfiguration


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.services.sql.connection;
19  
20  import java.util.Map  ;
21  
22  import org.sape.carbon.core.component.ComponentConfiguration;
23  
24  /**
25   * Configuration Interface for StandaloneConnectionFactory
26   *
27   * Copyright 2002 Sapient
28   * @since carbon 1.0
29   * @author Chris Herron, March 2002
30   * @version $Revision: 1.8 $($Author: araman $ / $Date: 2003/07/29 08:01:30 $)
31   */
32  public interface StandaloneConnectionFactoryConfiguration
33          extends ComponentConfiguration {
34  
35      /**
36       * Gets the class of the driver to create the connection with.
37       *
38       * @return Class of driver for connection.
39       */
40      Class   getDriverClass();
41  
42      /**
43       * Sets the class of the driver to create the connection with.
44       *
45       * @param driverClass Class of driver for connection.
46       */
47      void setDriverClass(Class   driverClass);
48  
49      /**
50       * Gets the DbUrl specifiying the database connection.
51       *
52       * @return the DbUrl specifiying the database connection
53       */
54      String   getDbUrl();
55  
56      /**
57       * Sets the DbUrl specifiying the database connection.
58       *
59       * @param dbUrl the DbUrl specifiying the database connection
60       */
61      void setDbUrl(String   dbUrl);
62  
63      /**
64       * Gets the DbUserId specifiying the database connection.
65       *
66       * @return the DbUserId specifiying the database connection
67       */
68      String   getDbUserId();
69  
70      /**
71       * Sets the DbUserId specifiying the database connection.
72       *
73       * @param dbUserId the DbUserId specifiying the database connection
74       */
75      void setDbUserId(String   dbUserId);
76  
77      /**
78       * Gets the DbPassword specifiying the database connection.
79       *
80       * @return the DbPassword specifiying the database connection
81       */
82      String   getDbPassword();
83  
84      /**
85       * Sets the DbPassword specifiying the database connection.
86       *
87       * @param dbPassword the dbPassword specifiying the database connection
88       */
89      void setDbPassword(String   dbPassword);
90      
91      /**
92       * Retrieves additional configuration properties set for the connection
93       */
94      Map   getConnectionProperties();
95      
96      /**
97       * Method to retrieve a specific configuration value property set for the connection
98       */
99      String   getConnectionProperties(String   key);
100     
101     /**
102      * Sets additional configuration values for the connection
103      */
104     void setConnectionProperties(Map   connectionProperties);
105     
106     /**
107      * Sets a specific configuration value for the connection 
108      */
109     void setConnectionProperties(String   key, String   value);
110 
111 }
112
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags