All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.netbeans.modules.tomcat5.config.TomcatDatasourceManager Maven / Gradle / Ivy

There is a newer version: RELEASE230
Show newest version
/*
 * 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.
 */

package org.netbeans.modules.tomcat5.config;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.enterprise.deploy.spi.DeploymentManager;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.modules.j2ee.deployment.common.api.ConfigurationException;
import org.netbeans.modules.j2ee.deployment.common.api.Datasource;
import org.netbeans.modules.j2ee.deployment.common.api.DatasourceAlreadyExistsException;
import org.netbeans.modules.j2ee.deployment.plugins.spi.DatasourceManager;
import org.netbeans.modules.tomcat5.deploy.TomcatManager;
import org.netbeans.modules.tomcat5.deploy.TomcatManager.TomcatVersion;
import org.netbeans.modules.tomcat5.config.gen.GlobalNamingResources;
import org.netbeans.modules.tomcat5.config.gen.Parameter;
import org.netbeans.modules.tomcat5.config.gen.ResourceParams;
import org.netbeans.modules.tomcat5.config.gen.Server;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

/**
 * DataSourceManager implementation
 *
 * @author sherold
 */
public class TomcatDatasourceManager implements DatasourceManager {

    private static final Logger LOGGER = Logger.getLogger(TomcatDatasourceManager.class.getName());

    private final TomcatManager tm;
    
    /**
     * Creates a new instance of TomcatDatasourceManager
     */
    public TomcatDatasourceManager(DeploymentManager dm) {
        tm = (TomcatManager) dm;
    }

    @CheckForNull
    public static Datasource createDatasource(String name, String data) {
        Properties props = new Properties();
        try {
            props.load(new StringReader(data));
        } catch (IOException ex) {
            LOGGER.log(Level.WARNING, null, ex);
            return null;
        }

        String username = props.getProperty("userName"); // NOI18N
        String url = props.getProperty("jdbcUrl"); // NOI18N
        String password = props.getProperty("password"); // NOI18N
        String driverClassName = props.getProperty("jdbcDriver"); // NOI18N
        if (name != null && username != null && url != null && driverClassName != null) {
            // return the datasource only if all the needed params are non-null except the password param
           return new TomcatDatasource(username, url, password, name, driverClassName);
        }
        return null;
    }

    @Override
    public Set getDatasources() throws ConfigurationException {
        Set result = new HashSet<>();
        result.addAll(getTomcatDatasources());
        result.addAll(getTomeeDatasources());
        return result;
    }

    /**
     * Get the global datasources defined in the GlobalNamingResources element
     * in the server.xml configuration file.
     */
    public Set getTomcatDatasources() {
        HashSet result = new HashSet<>();
        File serverXml = tm.getTomcatProperties().getServerXml();
        Server server;
        try {
            server = Server.createGraph(serverXml);
        } catch (IOException | RuntimeException e) {
            // server.xml file is most likely not parseable, log it and give up
            Logger.getLogger(TomcatDatasourceManager.class.getName()).log(Level.INFO, null, e);
            return Collections.emptySet();
        }
        GlobalNamingResources[] globalNamingResources = server.getGlobalNamingResources();
        if (globalNamingResources.length > 0) {
            // only one GlobalNamingResources element is allowed
            GlobalNamingResources globalNR = globalNamingResources[0];
            if (tm.getTomcatVersion() != TomcatVersion.TOMCAT_50) {
                // Tomcat 5.5.x or Tomcat 6.0.x
                int length = globalNR.getResource().length;
                for (int i = 0; i < length; i++) {
                    String type = globalNR.getResourceType(i);
                    if ("javax.sql.DataSource".equals(type)) { // NOI18N
                        String name     = globalNR.getResourceName(i);
                        String username = globalNR.getResourceUsername(i);
                        String url      = globalNR.getResourceUrl(i);
                        String password = globalNR.getResourcePassword(i);
                        String driverClassName = globalNR.getResourceDriverClassName(i);
                        if (name != null && username != null && url != null && driverClassName != null) {
                            // return the datasource only if all the needed params are non-null except the password param
                            result.add(new TomcatDatasource(username, url, password, name, driverClassName));
                        }
                    }
                }
            } else {
                // Tomcat 5.0.x
                int length = globalNR.getResource().length;
                ResourceParams[] resourceParams = globalNR.getResourceParams();
                for (int i = 0; i < length; i++) {
                    String type = globalNR.getResourceType(i);
                    if ("javax.sql.DataSource".equals(type)) { // NOI18N
                        String name = globalNR.getResourceName(i);
                        // find the resource params for the selected resource
                        for (int j = 0; j < resourceParams.length; j++) {
                            if (name.equals(resourceParams[j].getName())) {
                                Parameter[] params = resourceParams[j].getParameter();
                                HashMap paramNameValueMap = new HashMap(params.length);
                                for (Parameter parameter : params) {
                                    paramNameValueMap.put(parameter.getName(), parameter.getValue());
                                }
                                String username = (String) paramNameValueMap.get("username"); // NOI18N
                                String url      = (String) paramNameValueMap.get("url"); // NOI18N
                                String password = (String) paramNameValueMap.get("password"); // NOI18N
                                String driverClassName = (String) paramNameValueMap.get("driverClassName"); // NOI18N
                                if (username != null && url != null && driverClassName != null) {
                                    // return the datasource only if all the needed params are non-null except the password param
                                    result.add(new TomcatDatasource(username, url, password, name, driverClassName));
                                }
                            }
                        }
                    }
                }
            }
        }
        return result;
    }

    public Set getTomeeDatasources() {
        if (!tm.isTomEE()) {
            return Collections.emptySet();
        }

        File tomeeXml = tm.getTomcatProperties().getTomeeXml();
        if (tomeeXml == null) {
            return Collections.emptySet();
        }

        try {
            try (InputStream is = new BufferedInputStream(new FileInputStream(tomeeXml))) {
                SAXParserFactory factory = SAXParserFactory.newInstance();
                SAXParser saxParser = factory.newSAXParser();
                DatasourceHandler handler = new DatasourceHandler();
                saxParser.parse(is, handler);

                return handler.getDataSources();
            } catch (IOException e) {
                // ok, log it and give up
                Logger.getLogger(TomcatDatasourceManager.class.getName()).log(Level.INFO, null, e);
            }
        } catch (ParserConfigurationException | SAXException ex) {
            // ok, log it and give up
            Logger.getLogger(TomcatDatasourceManager.class.getName()).log(Level.INFO, null, ex);
        }
        return Collections.emptySet();
    }

    @Override
    public void deployDatasources(Set datasources)
            throws ConfigurationException, DatasourceAlreadyExistsException {
        // nothing needs to be done here
    }

    private static class DatasourceHandler extends DefaultHandler {

        private final StringBuilder content = new StringBuilder();

        private final Set dataSources = new HashSet<>();

        private boolean isResource = false;

        private String name;

        public Set getDataSources() {
            return dataSources;
        }

        @Override
        public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
            content.setLength(0);
            if ("Resource".equals(qName) // NOI18N
                    && "javax.sql.DataSource".equals(attributes.getValue("type"))  // NOI18N
                    && attributes.getValue("id") != null) {  // NOI18N
                isResource = true;
                name = attributes.getValue("id");  // NOI18N
            }
        }

        @Override
        public void endElement(String uri, String localName, String qName) throws SAXException {
            if (isResource) {
                if ("Resource".equals(qName)) {  // NOI18N
                    dataSources.add(createDatasource(name, content.toString()));
                    isResource = false;
                    name = null;
                }
            }
        }

        @Override
        public void characters(char[] ch, int start, int length) throws SAXException {
            if (isResource) {
                content.append(ch, start, length);
            }
        }

    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy