package-info.java example

Explorer
bboss-master
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * <p>
 * This package contains one public class which is a
 * <code>ConnectionPoolDataSource</code> (CPDS) implementation that can be used to
 * adapt older <code>Driver</code> based jdbc implementations. Below is an
 * example of setting up the CPDS to be available via JNDI in the
 * catalina servlet container.
 * </p>
 * <p>In server.xml, the following would be added to the <Context> for your
 * webapp:
 * </p>
 *
 * <pre>
 *  <Resource name="jdbc/bookstoreCPDS" auth="Container"
 *             type="com.frameworkset.commons.dbcp2.cpdsadapter.DriverAdapterCPDS"/>
 *   <ResourceParams name="jdbc/bookstoreCPDS">
 *     <parameter>
 *       <name>factory</name>
 *       <value>com.frameworkset.commons.dbcp2.cpdsadapter.DriverAdapterCPDS</value>
 *     </parameter>
 *         <parameter><name>user</name><value>root</value></parameter>
 *         <parameter><name>password</name><value></value></parameter>
 *         <parameter>
 *             <name>driver</name>
 *             <value>org.gjt.mm.mysql.Driver</value></parameter>
 *         <parameter>
 *              <name>url</name>
 *              <value>jdbc:mysql://localhost:3306/bookstore</value>
 *         </parameter>
 *   </ResourceParams>
 * </pre>
 *
 * <p>
 * In web.xml.  Note that elements must be given in the order of the dtd
 * described in the servlet specification:
 * </p>
 *
 * <pre>
 * <resource-ref>
 *   <description>
 *     Resource reference to a factory for java.sql.Connection
 *     instances that may be used for talking to a particular
 *     database that is configured in the server.xml file.
 *   </description>
 *   <res-ref-name>
 *     jdbc/bookstoreCPDS
 *   </res-ref-name>
 *   <res-type>
 *     com.frameworkset.commons.dbcp2.cpdsadapter.DriverAdapterCPDS
 *   </res-type>
 *   <res-auth>
 *     Container
 *   </res-auth>
 * </resource-ref>
 * </pre>
 *
 * <p>
 * Catalina deploys all objects configured similarly to above within the
 * <strong>java:comp/env</strong> namespace.
 * </p>
 */
package com.frameworkset.commons.dbcp2.cpdsadapter;