JDBCUrlParser.java

/**
 * H2GIS is a library that brings spatial support to the H2 Database Engine
 * <http://www.h2database.com>. H2GIS is developed by CNRS
 * <http://www.cnrs.fr/>.
 *
 * This code is part of the H2GIS project. H2GIS is free software; 
 * you can redistribute it and/or modify it under the terms of the GNU
 * Lesser General Public License as published by the Free Software Foundation;
 * version 3.0 of the License.
 *
 * H2GIS is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details <http://www.gnu.org/licenses/>.
 *
 *
 * For more information, please consult: <http://www.h2gis.org/>
 * or contact directly: info_at_h2gis.org
 */

package org.h2gis.utilities;

import org.osgi.service.jdbc.DataSourceFactory;

import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.util.Map;
import java.util.Properties;

/**
 * Convert JDBC URL into JDBC Connection properties.
 * Currently work with H2 and PostGreSQL DataSourceFactory
 * @author Nicolas Fortin
 */
public class JDBCUrlParser {
    private JDBCUrlParser() {}
    private static final String URL_STARTS = "jdbc:";
    /** If the property value of {@link DataSourceFactory#OSGI_JDBC_DRIVER_NAME} ends with SPATIAL_DATASOURCE_ENDSWITH
     *  then it is the wrapped spatial version of a DataSourceFactory  */
    public static final String SPATIAL_DATASOURCE_ENDSWITH = "_spatial";

    /**
     * Convert JDBC URL into JDBC Connection properties
     * @param jdbcUrl JDBC connection path
     * @return Properties to be used in OSGi DataSourceFactory that does not handle {@link DataSourceFactory#JDBC_URL}
     * @throws IllegalArgumentException Argument is not a valid JDBC connection URL or cannot be parsed by this class
     */
    public static Properties parse(String jdbcUrl) throws IllegalArgumentException {
        if(!jdbcUrl.startsWith(URL_STARTS)) {
            throw new IllegalArgumentException("JDBC Url must start with "+URL_STARTS);
        }
        String driverAndURI = jdbcUrl.substring(URL_STARTS.length());    
        Properties properties = new Properties();   
        URI uri = URI.create(driverAndURI.substring(driverAndURI.indexOf(':')+1));
        if(uri.getHost()!=null) {
            properties.setProperty(DataSourceFactory.JDBC_SERVER_NAME,uri.getHost());
        }
        // Read DataBase name/path and options
        String path = uri.getPath();
        if(path!=null) {
            String[] paths = path.split(";");
            if(uri.getHost()!=null && paths[0].startsWith("/")) {
                paths[0] = paths[0].substring(1);
            }
            properties.setProperty(DataSourceFactory.JDBC_DATABASE_NAME,paths[0]);
            for(int id=1;id<paths.length;id++) {
                String[] option = paths[id].split("=");
                if(option.length==2) {
                    properties.setProperty(option[0],option[1]);
                }
            }
        }
        String query = uri.getQuery();
        if(query!=null) {
            try {
                for(Map.Entry<String,String> entry : URIUtilities.getQueryKeyValuePairs(uri).entrySet()) {
                    properties.setProperty(entry.getKey(),entry.getValue());
                }
            } catch (UnsupportedEncodingException ex) {
                throw new IllegalArgumentException("JDBC Url encoding error",ex);

            }
        }
        if(uri.getPort()!=-1) {
            properties.setProperty(DataSourceFactory.JDBC_PORT_NUMBER,String.valueOf(uri.getPort()));
        }
        if(uri.getScheme()!=null && !"file".equalsIgnoreCase(uri.getScheme())) {
            properties.setProperty(DataSourceFactory.JDBC_NETWORK_PROTOCOL, uri.getScheme());
        }
        return properties;
    }

}