com.mysql.cj.conf.HostInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-java
Show all versions of mysql-connector-java
JDBC Type 4 driver for MySQL
/*
* Copyright (c) 2016, 2020, Oracle and/or its affiliates.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 2.0, as published by the
* Free Software Foundation.
*
* This program is also distributed with certain software (including but not
* limited to OpenSSL) that is licensed under separate terms, as designated in a
* particular file or component or in included license documentation. The
* authors of MySQL hereby grant you an additional permission to link the
* program and your derivative works with the separately licensed software that
* they have included with MySQL.
*
* Without limiting anything contained in the foregoing, this file, which is
* part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
* version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program 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 General Public License, version 2.0,
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.cj.conf;
import static com.mysql.cj.util.StringUtils.isNullOrEmpty;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
/**
* This class holds the following MySQL host information:
*
* - host: an IP or host name.
*
- port: the port number or 0 if not known.
*
- user: the user name.
*
- password: the password.
*
- host properties: host specific connection arguments.
*
*/
public class HostInfo implements DatabaseUrlContainer {
public static final int NO_PORT = -1;
private static final String HOST_PORT_SEPARATOR = ":";
private final DatabaseUrlContainer originalUrl;
private final String host;
private final int port;
private final String user;
private final String password;
private final Map hostProperties = new HashMap<>();
/**
* Constructs an empty {@link HostInfo} instance.
*/
public HostInfo() {
this(null, null, NO_PORT, null, null, null);
}
/**
* Constructs a {@link HostInfo} instance initialized with the provided host, port and user info.
*
* @param url
* a reference to the original database URL that produced this host info
* @param host
* the host ip or name
* @param port
* the port
* @param user
* the user name
* @param password
* the user's password
*/
public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password) {
this(url, host, port, user, password, null);
}
/**
* Constructs a {@link HostInfo} instance initialized with the provided host, port, user, password and connection arguments.
*
* @param url
* a reference to the original database URL that produced this host info
* @param host
* the host ip or name
* @param port
* the port
* @param user
* the user name
* @param password
* this user's password
* @param properties
* a connection arguments map.
*/
public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password, Map properties) {
this.originalUrl = url;
this.host = host;
this.port = port;
this.user = user;
this.password = password;
if (properties != null) {
this.hostProperties.putAll(properties);
}
}
/**
* Returns the host.
*
* @return the host
*/
public String getHost() {
return this.host;
}
/**
* Returns the port.
*
* @return the port
*/
public int getPort() {
return this.port;
}
/**
* Returns a host:port representation of this host.
*
* @return the host:port representation of this host
*/
public String getHostPortPair() {
return this.host + HOST_PORT_SEPARATOR + this.port;
}
/**
* Returns the user name.
*
* @return the user name
*/
public String getUser() {
return this.user;
}
/**
* Returns the password.
*
* @return the password
*/
public String getPassword() {
return this.password;
}
/**
* Returns the properties specific to this host.
*
* @return this host specific properties
*/
public Map getHostProperties() {
return Collections.unmodifiableMap(this.hostProperties);
}
/**
* Returns the connection argument for the given key.
*
* @param key
* key
*
* @return the connection argument for the given key
*/
public String getProperty(String key) {
return this.hostProperties.get(key);
}
/**
* Shortcut to the database connection argument.
*
* @return the database name
*/
public String getDatabase() {
String database = this.hostProperties.get(PropertyKey.DBNAME.getKeyName());
return isNullOrEmpty(database) ? "" : database;
}
/**
* Exposes this host info as a single properties instance. The values for host, port, user and password are added to the properties map with their standard
* keys.
*
* @return a {@link Properties} instance containing the full host information.
*/
public Properties exposeAsProperties() {
Properties props = new Properties();
this.hostProperties.entrySet().stream().forEach(e -> props.setProperty(e.getKey(), e.getValue() == null ? "" : e.getValue()));
props.setProperty(PropertyKey.HOST.getKeyName(), getHost());
props.setProperty(PropertyKey.PORT.getKeyName(), String.valueOf(getPort()));
if (getUser() != null) {
props.setProperty(PropertyKey.USER.getKeyName(), getUser());
}
if (getPassword() != null) {
props.setProperty(PropertyKey.PASSWORD.getKeyName(), getPassword());
}
return props;
}
/**
* Returns the original database URL that produced this host info.
*
* @return the original database URL
*/
@Override
public String getDatabaseUrl() {
return this.originalUrl != null ? this.originalUrl.getDatabaseUrl() : "";
}
/**
* Checks if this {@link HostInfo} has the same host and port pair as the given {@link HostInfo}.
*
* @param hi
* the {@link HostInfo} to compare with.
* @return
* true if both objects have equal host and port pairs, false otherwise.
*/
public boolean equalHostPortPair(HostInfo hi) {
return (getHost() != null && getHost().equals(hi.getHost()) || getHost() == null && hi.getHost() == null) && getPort() == hi.getPort();
}
/**
* Returns a string representation of this object.
*
* @return a string representation of this object
*/
@Override
public String toString() {
StringBuilder asStr = new StringBuilder(super.toString());
asStr.append(String.format(" :: {host: \"%s\", port: %d, hostProperties: %s}", this.host, this.port, this.hostProperties));
return asStr.toString();
}
}