org.mariadb.jdbc.JDBCUrl Maven / Gradle / Ivy
/*
MariaDB Client for Java
Copyright (c) 2012 Monty Program Ab.
This library 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; either version 2.1 of the License, or (at your option)
any later version.
This library 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.
You should have received a copy of the GNU Lesser General Public License along
with this library; if not, write to Monty Program Ab [email protected].
This particular MariaDB Client for Java file is work
derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
the following copyright and notice provisions:
Copyright (c) 2009-2011, Marcus Eriksson
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
Neither the name of the driver nor the names of its contributors may not be
used to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
package org.mariadb.jdbc;
import org.mariadb.jdbc.internal.common.DefaultOptions;
import org.mariadb.jdbc.internal.common.Options;
import org.mariadb.jdbc.internal.common.ParameterConstant;
import org.mariadb.jdbc.internal.common.UrlHAMode;
import org.mariadb.jdbc.internal.common.query.IllegalParameterException;
import java.sql.SQLException;
import java.util.List;
import java.util.Properties;
/**
* parse and verification of URL.
*
*
* basic syntax :
* {@code jdbc:(mysql|mariadb):[replication:|loadbalance:|aurora:]//[,]/[database>][?=[&=]] }
*
*
* hostDescription:
* - simple :
* {@code :}
* (for example localhost:3306)
* - complex :
* {@code address=[(type=(master|slave))][(port=)](host=)}
*
* type is by default master
* port is by default 3306
*
*
* host can be dns name, ipv4 or ipv6.
* in case of ipv6 and simple host description, the ip must be written inside bracket.
* exemple : {@code jdbc:mysql://[2001:0660:7401:0200:0000:0000:0edf:bdd7]:3306}
*
*
* Some examples :
* {@code jdbc:mysql://localhost:3306/database?user=greg&password=pass}
* {@code jdbc:mysql://address=(type=master)(host=master1),address=(port=3307)(type=slave)(host=slave1)/database?user=greg&password=pass}
*
*/
public class JDBCUrl {
private String database;
private Options options;
private List addresses;
private UrlHAMode haMode;
private JDBCUrl(){};
protected JDBCUrl(String database, List addresses, Options options, UrlHAMode haMode) throws SQLException {
this.options = options;
this.database = database;
this.addresses = addresses;
this.haMode = haMode;
if (haMode == UrlHAMode.AURORA) {
for (HostAddress hostAddress : addresses) hostAddress.type = null;
} else {
for (HostAddress hostAddress : addresses) {
if (hostAddress.type == null)hostAddress.type = ParameterConstant.TYPE_MASTER;
}
}
}
static boolean acceptsURL(String url) {
return (url != null) &&
(url.startsWith("jdbc:mariadb:") || url.startsWith("jdbc:mysql:"));
}
public static JDBCUrl parse(final String url) throws SQLException {
return parse(url, new Properties());
}
public static JDBCUrl parse(final String url, Properties prop) throws SQLException {
if (url != null) {
if (prop == null) prop = new Properties();
if (url.startsWith("jdbc:mysql:")) {
JDBCUrl jdbcUrl = new JDBCUrl();
parseInternal(jdbcUrl, url, prop);
return jdbcUrl;
}
String[] arr = new String[]{"jdbc:mysql:thin:", "jdbc:mariadb:"};
for (String prefix : arr) {
if (url.startsWith(prefix)) {
JDBCUrl jdbcUrl = new JDBCUrl();
parseInternal(jdbcUrl, "jdbc:mysql:" + url.substring(prefix.length()), prop);
return jdbcUrl;
}
}
}
return null;
}
public void parseUrl(String url) throws SQLException {
if (url.startsWith("jdbc:mysql:")) {
parseInternal(this, url, new Properties());
}
String[] arr = new String[]{"jdbc:mysql:thin:", "jdbc:mariadb:"};
for (String prefix : arr) {
if (url.startsWith(prefix)) {
parseInternal(this, url, new Properties());
}
}
}
/*
Parse ConnectorJ compatible urls
jdbc:mysql://host:port/database
Example: jdbc:mysql://localhost:3306/test?user=root&password=passwd
*/
private static void parseInternal(JDBCUrl jdbcUrl, String url, Properties properties) throws SQLException {
try {
String[] baseTokens = url.substring(0,url.indexOf("//")).split(":");
//parse HA mode
jdbcUrl.haMode = UrlHAMode.NONE;
if (baseTokens.length > 2) {
try {
jdbcUrl.haMode = UrlHAMode.valueOf(baseTokens[2].toUpperCase());
}catch (IllegalArgumentException i) {
throw new IllegalArgumentException("url parameter error '" + baseTokens[2] +"' is a unknown parameter in the url "+url);
}
}
url = url.substring(url.indexOf("//") + 2);
String[] tokens = url.split("/");
String hostAddressesString= tokens[0];
String additionalParameters = (tokens.length > 1) ? url.substring(tokens[0].length() + 1) : null;
jdbcUrl.addresses = HostAddress.parse(hostAddressesString, jdbcUrl.haMode);
if (additionalParameters == null) {
jdbcUrl.database = null;
jdbcUrl.options = DefaultOptions.parse(jdbcUrl.haMode, "",properties);
} else {
int ind = additionalParameters.indexOf('?');
if (ind > -1) {
jdbcUrl.database = additionalParameters.substring(0, ind);
jdbcUrl.options = DefaultOptions.parse(jdbcUrl.haMode, additionalParameters.substring(ind + 1),properties);
} else {
jdbcUrl.database = additionalParameters;
jdbcUrl.options = DefaultOptions.parse(jdbcUrl.haMode, "",properties);
}
}
if (jdbcUrl.haMode == UrlHAMode.AURORA) {
for (HostAddress hostAddress : jdbcUrl.addresses) hostAddress.type = null;
} else {
for (HostAddress hostAddress : jdbcUrl.addresses) {
if (hostAddress.type == null) hostAddress.type = ParameterConstant.TYPE_MASTER;
}
}
} catch (IllegalArgumentException i) {
throw new SQLException(i.getMessage());
}
}
public String getUsername() {
return options.user;
}
public String getPassword() {
return options.password;
}
public String getDatabase() {
return database;
}
public List getHostAddresses() {
return this.addresses;
}
protected void setUsername(String username) {
options.user = username;
}
protected void setPassword(String password) {
options.password = password;
}
public Options getOptions() {
return options;
}
protected void setDatabase(String database) {
this.database = database;
}
protected void setProperties(String urlParameters) {
DefaultOptions.parse(this.haMode, urlParameters, this.options);
}
public String toString() {
String s = "jdbc:mysql://";
if (!haMode.equals(UrlHAMode.NONE)) s = "jdbc:mysql:"+haMode.toString().toLowerCase()+"://";
if (addresses != null)
s += HostAddress.toString(addresses);
if (database != null)
s += "/" + database;
return s;
}
public UrlHAMode getHaMode() {
return haMode;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy