001: /*
002: * The contents of this file are subject to the Sapient Public License
003: * Version 1.0 (the "License"); you may not use this file except in compliance
004: * with the License. You may obtain a copy of the License at
005: * http://carbon.sf.net/License.html.
006: *
007: * Software distributed under the License is distributed on an "AS IS" basis,
008: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
009: * the specific language governing rights and limitations under the License.
010: *
011: * The Original Code is The Carbon Component Framework.
012: *
013: * The Initial Developer of the Original Code is Sapient Corporation
014: *
015: * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
016: */
017:
018: package org.sape.carbon.services.sql.connection;
019:
020: import java.util.Map;
021:
022: import org.sape.carbon.core.component.ComponentConfiguration;
023:
024: /**
025: * Configuration Interface for StandaloneConnectionFactory
026: *
027: * Copyright 2002 Sapient
028: * @since carbon 1.0
029: * @author Chris Herron, March 2002
030: * @version $Revision: 1.8 $($Author: araman $ / $Date: 2003/07/29 08:01:30 $)
031: */
032: public interface StandaloneConnectionFactoryConfiguration extends
033: ComponentConfiguration {
034:
035: /**
036: * Gets the class of the driver to create the connection with.
037: *
038: * @return Class of driver for connection.
039: */
040: Class getDriverClass();
041:
042: /**
043: * Sets the class of the driver to create the connection with.
044: *
045: * @param driverClass Class of driver for connection.
046: */
047: void setDriverClass(Class driverClass);
048:
049: /**
050: * Gets the DbUrl specifiying the database connection.
051: *
052: * @return the DbUrl specifiying the database connection
053: */
054: String getDbUrl();
055:
056: /**
057: * Sets the DbUrl specifiying the database connection.
058: *
059: * @param dbUrl the DbUrl specifiying the database connection
060: */
061: void setDbUrl(String dbUrl);
062:
063: /**
064: * Gets the DbUserId specifiying the database connection.
065: *
066: * @return the DbUserId specifiying the database connection
067: */
068: String getDbUserId();
069:
070: /**
071: * Sets the DbUserId specifiying the database connection.
072: *
073: * @param dbUserId the DbUserId specifiying the database connection
074: */
075: void setDbUserId(String dbUserId);
076:
077: /**
078: * Gets the DbPassword specifiying the database connection.
079: *
080: * @return the DbPassword specifiying the database connection
081: */
082: String getDbPassword();
083:
084: /**
085: * Sets the DbPassword specifiying the database connection.
086: *
087: * @param dbPassword the dbPassword specifiying the database connection
088: */
089: void setDbPassword(String dbPassword);
090:
091: /**
092: * Retrieves additional configuration properties set for the connection
093: */
094: Map getConnectionProperties();
095:
096: /**
097: * Method to retrieve a specific configuration value property set for the connection
098: */
099: 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: }
|