KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > sql > connection > NamedDataSourceConnectionFactoryConfiguration


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 org.sape.carbon.core.component.ComponentConfiguration;
21
22 /**
23  * Configuration Interface for NamedDataSourceConnectionFactory.
24  * The <code>JndiUserId, JndiPassword, DataSourceUserId and
25  * DataSourcePassword</code> are all optional - but may be required by the
26  * Vendor's implementation, or your setup of JNDI + DataSource + JDBC.
27  *
28  * @since carbon 1.0
29  * @author Chris Herron, March 2002
30  * @version $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:37 $)
31  * <br>Copyright 2002 Sapient
32  */

33 public interface NamedDataSourceConnectionFactoryConfiguration
34         extends ComponentConfiguration {
35
36     /**
37      * Gets the JNDI name of the datasource to retreive.
38      *
39      * @return JNDI name of the datasource to retreive
40      */

41     String JavaDoc getJndiName();
42
43     /**
44      * Sets the JNDI name of the datasource to retreive.
45      *
46      * @param jndiName JNDI name of the datasource to retreive
47      */

48     void setJndiName(String JavaDoc jndiName);
49
50     /**
51      * Gets the name of the initial context factory used to retreive the
52      * datasource.
53      *
54      * @return name of the initial context factory
55      */

56     String JavaDoc getInitialContextFactory();
57
58     /**
59      * Sets the name of the initial context factory used to retreive the
60      * datasource.
61      *
62      * @param initialContextFactory name of the initial context factory
63      */

64     void setInitialContextFactory(Class JavaDoc initialContextFactory);
65
66     /**
67      * Gets the provider Url for the datasource.
68      *
69      * @return the provider Url
70      */

71     String JavaDoc getProviderUrl();
72
73     /**
74      * Sets the provider Url for the datasource.
75      *
76      * @param providerUrl the provider Url
77      */

78     void setProviderUrl(String JavaDoc providerUrl);
79
80     /**
81      * (Optional) Gets the name of the jndi user to authenticate with.
82      *
83      * @return name of the jndi user to authenticate with
84      */

85     String JavaDoc getJndiUserId();
86
87     /**
88      * (Optional) Sets the name of the jndi user to authenticate with.
89      *
90      * @param jndiUserId name of the jndi user to authenticate with
91      */

92     void setJndiUserId(String JavaDoc jndiUserId);
93
94     /**
95      * (Optional) Gets the name of the jndi password to authenticate with.
96      *
97      * @return name of the jndi password to authenticate with
98      */

99     String JavaDoc getJndiPassword();
100
101     /**
102      * (Optional) Sets the name of the jndi password to authenticate with.
103      *
104      * @param jndiPassword name of the jndi password to authenticate with
105      */

106     void setJndiPassword(String JavaDoc jndiPassword);
107
108     /**
109      * (Optional) Gets the name of the datasource id to authenticate with.
110      *
111      * @return name of the datasource id to authenticate with
112      */

113     String JavaDoc getDataSourceUserId();
114
115     /**
116      * (Optional) Sets the name of the datasource id to authenticate with.
117      *
118      * @param dataSourceUserId name of the datasource id to authenticate with
119      */

120     void setDataSourceUserId(String JavaDoc dataSourceUserId);
121
122     /**
123      * (Optional) Gets the name of the datasource password to
124      * authenticate with.
125      *
126      * @return name of the datasource password to authenticate with
127      */

128     String JavaDoc getDataSourcePassword();
129
130     /**
131      * (Optional) Sets the name of the datasource password to
132      * authenticate with.
133      *
134      * @param dataSourcePassword name of the datasource password
135      * to authenticate with
136      */

137     void setDataSourcePassword(String JavaDoc dataSourcePassword);
138
139 }
140
Popular Tags