ca.nrc.cadc.db.ConnectionConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-util Show documentation
OpenCADC core utility library
There is a newer version: 1.11.5
/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2016.                            (c) 2016.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits réservés
*
*  NRC disclaims any warranties,        Le CNRC dénie toute garantie
*  expressed, implied, or               énoncée, implicite ou légale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           être tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou général,
*  arising from the use of the          accessoire ou fortuit, résultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        être utilisés pour approuver ou
*  products derived from this           promouvoir les produits dérivés
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  préalable et particulière
*                                       par écrit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la “GNU Affero General Public
*  License as published by the          License” telle que publiée
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit (à votre gré)
*  any later version.                   toute version ultérieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribué
*  hope that it will be useful,         dans l’espoir qu’il vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans même la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
*  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Générale Publique GNU Affero
*  more details.                        pour plus de détails.
*
*  You should have received             Vous devriez avoir reçu une
*  a copy of the GNU Affero             copie de la Licence Générale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
*  .      pas le cas, consultez :
*                                       .
*
*  $Revision: 5 $
*
************************************************************************
*/

package ca.nrc.cadc.db;

import ca.nrc.cadc.util.HashUtil;
import java.io.Serializable;

/**
 * Simple class to store connection information. This class stores information
 * to connect to a server via JDBC.
 *
 * @version $Revision: 245 $
 * @author $Author: jenkinsd $
 */
public class ConnectionConfig implements Serializable {
    private static final long serialVersionUID = 201103241000L;

    private String server;
    private String database;

    private String username;
    private String password;

    private String driver;
    private String url;

    public ConnectionConfig(String server, String database, String username, String password, String driver,
            String url) {
        this.server = server;
        this.database = database;

        this.username = username;
        this.password = password;

        this.driver = driver;
        this.url = url;
    }

    // package access: called by DBConfig only
    void setDriver(String s) {
        this.driver = s;
    }

    void setURL(String s) {
        this.url = s;
    }

    public final boolean matches(String server, String database) {
        return matches(server, database, true);
    }

    public final boolean matches(final String server, final String database, final boolean matchWildcard) {
        final boolean dbMatch;

        if (matchWildcard) {
            dbMatch = this.database.equals(database) || isWildcardDatabase();
        } else {
            dbMatch = this.database.equals(database);
        }

        return this.server.equals(server) && dbMatch;
    }

    /**
     * Obtain whether this configuration allows any database.
     * 
     * @return True if wildcard (any database), false otherwise.
     */
    public final boolean isWildcardDatabase() {
        return this.database.equals("*");
    }

    public String getServer() {
        return server;
    }

    public String getDatabase() {
        return database;
    }

    public String getUsername() {
        return username;
    }

    public String getPassword() {
        return password;
    }

    public String getDriver() {
        return driver;
    }

    public String getURL() {
        return url;
    }

    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }

        if ((o == null) || (getClass() != o.getClass())) {
            return false;
        }

        final ConnectionConfig that = (ConnectionConfig) o;

        if (database != null ? !database.equals(that.database) : that.database != null) {
            return false;
        }

        if (driver != null ? !driver.equals(that.driver) : that.driver != null) {
            return false;
        }

        if (password != null ? !password.equals(that.password) : that.password != null) {
            return false;
        }

        if (server != null ? !server.equals(that.server) : that.server != null) {
            return false;
        }

        if (url != null ? !url.equals(that.url) : that.url != null) {
            return false;
        }

        return !(username != null ? !username.equals(that.username) : that.username != null);
    }

    public int hashCode() {
        int result = HashUtil.hash(HashUtil.SEED, server);
        result = HashUtil.hash(result, database);
        result = HashUtil.hash(result, username);
        result = HashUtil.hash(result, password);
        result = HashUtil.hash(result, driver);

        return HashUtil.hash(result, url);
    }
}