PostgresConnectionSettings.java

Go to the documentation of this file.

/*
 * Central Repository
 *
 * Copyright 2015-2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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 org.sleuthkit.autopsy.centralrepository.datamodel;

import java.util.Objects;
import java.util.regex.Pattern;

public class PostgresConnectionSettings {
    private final static String DB_NAMES_REGEX = "[a-z][a-z0-9_]*"; // only lower case
    private final static String DB_USER_NAMES_REGEX = "[a-zA-Z]\\w*";
    
    public final static String DEFAULT_HOST = ""; // NON-NLS
    public final static int DEFAULT_PORT = 5432;
    public final static String DEFAULT_DBNAME = "central_repository"; // NON-NLS
    public final static String DEFAULT_USERNAME = "";
    public final static String DEFAULT_PASSWORD = "";
    
    private static void validateStr(String s, String errMessage) throws CentralRepoException {
        if (null == s || s.isEmpty())
            throw new CentralRepoException(errMessage);
    }
    
    private static void validateRegex(String s, String pattern, String errMessage) throws CentralRepoException {
        if (!Pattern.matches(pattern, s))
            throw new CentralRepoException(errMessage);
    }
    
    private static void validateNum(int num, Integer min, Integer max, String errMessage) throws CentralRepoException {
        if ((min != null && num < min) || (max != null && num > max))
            throw new CentralRepoException(errMessage);
    }
    
    private String host = DEFAULT_HOST;
    private int port = DEFAULT_PORT;
    private String dbName = DEFAULT_DBNAME;
    private int bulkThreshold = RdbmsCentralRepo.DEFAULT_BULK_THRESHHOLD;
    private String userName = DEFAULT_USERNAME;
    private String password = DEFAULT_PASSWORD;

    public String getHost() {
        return host;
    }

    public int getPort() {
        return port;
    }

    public String getDbName() {
        return dbName;
    }

    public int getBulkThreshold() {
        return bulkThreshold;
    }

    public String getUserName() {
        return userName;
    }

    public String getPassword() {
        return password;
    }
    
 
    public void setHost(String host) throws CentralRepoException {
        validateStr(host, "Invalid host name. Cannot be empty.");
        this.host = host;
    }


    public void setPort(int port) throws CentralRepoException {
        validateNum(port, 1, 65535, "Invalid port. Must be a number greater than 0.");
        this.port = port;
    }


    public void setDbName(String dbName) throws CentralRepoException {
        validateStr(dbName, "Invalid database name. Cannot be empty."); // NON-NLS
        validateRegex(dbName, DB_NAMES_REGEX, 
            "Invalid database name. Name must start with a lowercase letter and can only contain lowercase letters, numbers, and '_'."); // NON-NLS

        this.dbName = dbName.toLowerCase();
    }

    
    public void setBulkThreshold(int bulkThreshold) throws CentralRepoException {
        validateNum(bulkThreshold, 1, null, "Invalid bulk threshold.");
        this.bulkThreshold = bulkThreshold;
    }

    
    public void setUserName(String userName) throws CentralRepoException {
        validateStr(userName, "Invalid user name. Cannot be empty."); // NON-NLS
        validateRegex(userName, DB_USER_NAMES_REGEX, 
            "Invalid user name. Name must start with a letter and can only contain letters, numbers, and '_'.");
        
        this.userName = userName;
    }

    
    public void setPassword(String password) throws CentralRepoException {
        validateStr(password, "Invalid user password. Cannot be empty.");
        this.password = password;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 43 * hash + Objects.hashCode(this.host);
        hash = 43 * hash + this.port;
        hash = 43 * hash + Objects.hashCode(this.dbName);
        hash = 43 * hash + this.bulkThreshold;
        hash = 43 * hash + Objects.hashCode(this.userName);
        hash = 43 * hash + Objects.hashCode(this.password);
        return hash;
    }
    

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final PostgresConnectionSettings other = (PostgresConnectionSettings) obj;
        if (this.port != other.port) {
            return false;
        }
        if (this.bulkThreshold != other.bulkThreshold) {
            return false;
        }
        if (!Objects.equals(this.host, other.host)) {
            return false;
        }
        if (!Objects.equals(this.dbName, other.dbName)) {
            return false;
        }
        if (!Objects.equals(this.userName, other.userName)) {
            return false;
        }
        if (!Objects.equals(this.password, other.password)) {
            return false;
        }
        return true;
    }
}