001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005 *
006 * The contents of this file are subject to the terms of either the GNU
007 * General Public License Version 2 only ("GPL") or the Common
008 * Development and Distribution License("CDDL") (collectively, the
009 * "License"). You may not use this file except in compliance with the
010 * License. You can obtain a copy of the License at
011 * http://www.netbeans.org/cddl-gplv2.html
012 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013 * specific language governing permissions and limitations under the
014 * License. When distributing the software, include this License Header
015 * Notice in each file and include the License file at
016 * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017 * particular file as subject to the "Classpath" exception as provided
018 * by Sun in the GPL Version 2 section of the License file that
019 * accompanied this code. If applicable, add the following below the
020 * License Header, with the fields enclosed by brackets [] replaced by
021 * your own identifying information:
022 * "Portions Copyrighted [year] [name of copyright owner]"
023 *
024 * Contributor(s):
025 *
026 * The Original Software is NetBeans. The Initial Developer of the Original
027 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028 * Microsystems, Inc. All Rights Reserved.
029 *
030 * If you wish your version of this file to be governed by only the CDDL
031 * or only the GPL Version 2, indicate your decision by adding
032 * "[Contributor] elects to include this software in this distribution
033 * under the [CDDL or GPL Version 2] license." If you do not indicate a
034 * single choice of license, a recipient has the option to distribute
035 * your version of this file under either the CDDL, the GPL Version 2 or
036 * to extend the choice of license to its licensees as provided above.
037 * However, if you add GPL Version 2 code and therefore, elected the GPL
038 * Version 2 license, then the option applies only if the new code is
039 * made subject to such option by the copyright holder.
040 */
041
042 package org.netbeans.modules.j2ee.deployment.plugins.spi.config;
043
044 import java.util.Set;
045 import org.netbeans.modules.j2ee.deployment.common.api.ConfigurationException;
046 import org.netbeans.modules.j2ee.deployment.common.api.Datasource;
047 import org.netbeans.modules.j2ee.deployment.common.api.DatasourceAlreadyExistsException;
048
049 /**
050 * Configuration useful for managing module data sources.
051 * <p>
052 * Implementation of this interface should be registered in the {@link ModuleConfiguration}
053 * lookup.
054 *
055 * @since 1.23
056 * @author sherold
057 */
058 public interface DatasourceConfiguration {
059
060 /**
061 * Returns the data sources defined in the module.
062 *
063 * @return a set of data sources defined in the module.
064 *
065 * @throws ConfigurationException reports problems in retrieving data source
066 * definitions.
067 */
068 Set<Datasource> getDatasources() throws ConfigurationException;
069
070 /**
071 * Returns true if data source creation is supported, false otherwise.
072 *
073 * @return true if data source creation is supported, false otherwise.
074 */
075 boolean supportsCreateDatasource();
076
077 /**
078 * Creates the data source definition in the module.
079 *
080 * @param jndiName data source JNDI name.
081 * @param url database URL.
082 * @param username database user.
083 * @param password user's password.
084 * @param driver fully qualified name of the database driver class.
085 *
086 * @return created data source.
087 *
088 * @throws UnsupportedOperationException if operation is not supported.
089 * @throws ConfigurationException reports problems in creating data source
090 * definition.
091 * @throws DatasourceAlreadyExistsException if a data source with the same
092 * JNDI name already exists.
093 */
094 Datasource createDatasource(String jndiName, String url,
095 String username, String password, String driver)
096 throws UnsupportedOperationException,
097 ConfigurationException, DatasourceAlreadyExistsException;
098
099 /**
100 * Binds the data source reference name with the corresponding data source which is
101 * identified the given JNDI name.
102 *
103 * @param referenceName name used to identify the data source
104 * @param jndiName JNDI name of the data source
105 * @throws ConfigurationException if there is some problem with data source configuration
106 *
107 * @since 1.25
108 */
109 void bindDatasourceReference(String referenceName, String jndiName)
110 throws ConfigurationException;
111
112 /**
113 * Binds the data source reference name with the corresponding data source which is
114 * identified the given JNDI name. The reference is used within the scope of the EJB.
115 *
116 * @param ejbName EJB name
117 * @param ejbType EJB type - the possible values are
118 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.SESSION,
119 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.ENTITY and
120 * org.netbeans.modules.j2ee.dd.api.ejb.EnterpriseBeans.MESSAGE_DRIVEN
121 * @param referenceName name used to identify the data source
122 * @param jndiName JNDI name of the data source
123 *
124 * @throws ConfigurationException if there is some problem with data source configuration
125 *
126 * @since 1.25
127 */
128 void bindDatasourceReferenceForEjb(String ejbName, String ejbType,
129 String referenceName, String jndiName)
130 throws ConfigurationException;
131
132 /**
133 * Finds JNDI name of the data source which is mapped to the given reference name.
134 *
135 * @param referenceName reference name
136 *
137 * @return JNDI name of the data source if the mapping exists, null otherwise
138 *
139 * @throws ConfigurationException if there is some problem with data source configuration
140 *
141 * @since 1.25
142 */
143 String findDatasourceJndiName(String referenceName)
144 throws ConfigurationException;
145
146 /**
147 * Finds JNDI name of the data source which is mapped to the given reference name in the scope the EJB.
148 *
149 * @param ejbName EJB name
150 * @param referenceName reference name
151 * @return JNDI name of the data source if the mapping exists, null otherwise
152 *
153 * @throws ConfigurationException if there is some problem with data source configuration
154 *
155 * @since 1.25
156 */
157 String findDatasourceJndiNameForEjb(String ejbName,
158 String referenceName) throws ConfigurationException;
159 }
|