AbstractSQLDatabase.java

/*
 * Copyright 2011-2012 Brian Matthews
 *
 * Licensed 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 com.btmatthews.maven.plugins.inmemdb.db;

import com.btmatthews.maven.plugins.inmemdb.SQLDatabase;

import java.util.HashMap;
import java.util.Map;

/**
 * Abstract base classes embedded SQL databases.
 *
 * @author <a href="mailto:brian@btmatthews.com">Brian Matthews</a>
 * @version 1.0.0
 */
public abstract class AbstractSQLDatabase extends AbstractDatabase implements SQLDatabase {

    /**
     * Constructor initializes default database port.
     *
     * @param port The default port.
     */
    public AbstractSQLDatabase(final int port) {
        super(port);
    }

    /**
     * Get the database connection protocol.
     *
     * @return The database connection protocol.
     */
    protected abstract String getUrlProtocol();

    /**
     * Construct the JDBC URL without addtional connection specific attributes.
     *
     * @return The JDC URL.
     */
    public final String getUrl() {
        return getUrl(new HashMap<String, String>());
    }

    /**
     * Construct the JDBC URL with connection specific attributes.
     *
     * @param additionalAttributes The connection specific attributes.
     * @return The JDBC URL.
     */
    public final String getUrl(final Map<String, String> additionalAttributes) {
        final StringBuilder url = new StringBuilder("jdbc:");
        url.append(getUrlProtocol());
        url.append(getDatabaseName());
        final Map<String, String> mergedAttributes = new HashMap<String, String>(getAttributes());
        mergedAttributes.putAll(additionalAttributes);
        if (mergedAttributes.size() > 0) {
            for (final Map.Entry<String, String> entry : mergedAttributes.entrySet()) {
                url.append(';');
                url.append(entry.getKey());
                url.append('=');
                url.append(entry.getValue());
            }
        }
        return url.toString();
    }
}