com.aceql.jdbc.commons.driver.util.DriverUtil Maven / Gradle / Ivy
Show all versions of aceql-http-client-jdbc-driver Show documentation
/*
* This file is part of AceQL JDBC Driver.
* AceQL JDBC Driver: Remote JDBC access over HTTP with AceQL HTTP.
* Copyright (c) 2023, KawanSoft SAS
* (http://www.kawansoft.com). All rights reserved.
*
* 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.aceql.jdbc.commons.driver.util;
import java.net.InetSocketAddress;
import java.net.MalformedURLException;
import java.net.Proxy;
import java.net.Proxy.Type;
import java.net.URL;
import java.sql.SQLException;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.Set;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import com.aceql.jdbc.commons.main.util.framework.FrameworkDebug;
import com.aceql.jdbc.commons.main.util.framework.JdbcUrlHeader;
import com.aceql.jdbc.commons.main.util.framework.Tag;
import com.aceql.jdbc.commons.metadata.ResultSetMetaDataPolicy;
/**
*
* Utility method for AceQLDriver class
*
* @author Nicolas de Pomereu
*
*/
public class DriverUtil {
/** The debug flag */
private static boolean DEBUG = FrameworkDebug.isSet(DriverUtil.class);
/** IP pattern */
private static final Pattern PATTERN = Pattern
.compile("^(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.){3}([01]?\\d\\d?|2[0-4]\\d|25[0-5])$");
public static final String REQUEST_PROPERTY = "request-property-";
/**
* No constructor
*/
protected DriverUtil() {
}
/**
* Add the properties defined as parameters in the URL
*
* @param url the URL of the database to which to connect
* @param info a list of arbitrary string tag/value pairs as connection
* arguments. At least a "user" and "password" property should be
* included.
* @return the updated Properties
*/
public static Properties addPropertiesFromUrl(final String url, final Properties info) {
if (!url.contains("?")) {
return info;
}
Properties newInfo = new Properties();
if (info != null) {
newInfo.putAll(info);
}
String query = StringUtils.substringAfter(url, "?");
Map mapProps = DriverUtil.getQueryMap(query);
Set set = mapProps.keySet();
for (String propName : set) {
newInfo.setProperty(propName, mapProps.get(propName));
}
return newInfo;
}
/**
* 1) Remove all after first ? 2) Remove "jdbc:aceql:" prefix
*
* @param url
* @return the trimmed url without parameters & without jdbc:aceql:" prefix
*/
public static String trimUrl(final String url) {
String newUrl = url;
if (newUrl.startsWith(JdbcUrlHeader.JDBC_URL_HEADER)) {
newUrl = StringUtils.substringAfter(newUrl, JdbcUrlHeader.JDBC_URL_HEADER);
}
newUrl = StringUtils.substringBefore(newUrl, "?");
return newUrl;
}
/**
* Return true if the passed string is an URL with HTTP(S) protocol
*
* @param url the URL to test
* @return true if the URL is HTTP
*/
public static boolean isHttpProtocolUrl(String url) {
URL theUrl = null;
try {
theUrl = new URL(url);
} catch (MalformedURLException e) {
return false;
}
String protocol = theUrl.getProtocol();
return protocol.equals("http") || protocol.equals("https");
}
/**
* @param info
* @return
*/
public static boolean getGzipResult(Properties info) {
String compressionObj = info.getProperty("gzipResult");
if (compressionObj == null) {
return true;
}
boolean compression = Boolean.parseBoolean(compressionObj);
return compression;
}
/**
* get the read timeout.
*
* @param info
* @return the connect timeout
* @throws SQLException
*/
public static int getReadTimeout(Properties info) throws SQLException {
String readTimeoutStr = info.getProperty("readTimeout");
if (readTimeoutStr == null) {
return 0;
}
int readTimeout = 0;
try {
readTimeout = Integer.parseInt(readTimeoutStr);
} catch (NumberFormatException e) {
throw new SQLException(Tag.PRODUCT + " Invalid readTimeout, is not numeric: " + readTimeoutStr);
}
return readTimeout;
}
/**
* get the connect timeout.
*
* @param info
* @return the connect timeout
* @throws SQLException
*/
public static int getConnectTimeout(Properties info) throws SQLException {
String connectTimeoutStr = info.getProperty("connectTimeout");
if (connectTimeoutStr == null) {
return 0;
}
int connectTimeout = 0;
try {
connectTimeout = Integer.parseInt(connectTimeoutStr);
} catch (NumberFormatException e) {
throw new SQLException(Tag.PRODUCT + " Invalid connectTimeout, is not numeric: " + connectTimeoutStr);
}
return connectTimeout;
}
/**
* Extract from an URL query part the parameters and build a map
*
* @param query the URL query part to extract parmaters
* @return the Map of [parameter name, parameter value]
*/
public static Map getQueryMap(String query) {
String[] params = query.split("&");
Map map = new HashMap();
for (String param : params) {
String[] p = param.split("=");
String name = p[0];
if (p.length > 1) {
String value = p[1];
map.put(name, value);
debug("name / value: " + name + " / " + value);
}
}
return map;
}
/**
* Copy a set of properties from one Property to another.
*
*
* @param srcProp Source set of properties to copy from.
* @param destProp Dest Properties to copy into.
*
**/
public static void copyProperties(Properties srcProp, Properties destProp) {
for (Enumeration propertyNames = srcProp.propertyNames(); propertyNames.hasMoreElements();) {
Object key = propertyNames.nextElement();
destProp.put(key, srcProp.get(key));
}
}
/**
* Allows to validate an IP format
*
* @param ip the IP to test
* @return true if the string contains an IP format
*/
public static boolean validateIpFormat(final String ip) {
Objects.requireNonNull(ip, "ip cannot be null!");
return PATTERN.matcher(ip).matches();
}
/*
* Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress( "localhost",
* 8080));
*
* System.out.println(proxy.toString()); //HTTP @ localhost/127.0.0.1:8080
*/
/**
* debug tool
*/
private static void debug(String s) {
if (DEBUG) {
System.out.println(new Date() + " " + s);
}
}
/**
* Builds the Proxy instance.
*
* @param proxyType defaults to HTTP if null.
* @param proxyHostname required. If not set, no Proxy will be defined (method will return null)
* @param proxyPort the Proxy port, must be a numeric value
* @return the created Proxy instance
* @throws SQLException
*/
public static Proxy buildProxy(String proxyType, String proxyHostname, String proxyPort) throws SQLException {
// If proxyType is null, empty od DIRECT ==> no proxy in use.
if (proxyType == null || proxyType.isEmpty() || proxyType.equals(Type.DIRECT.toString())) {
return null;
}
if (proxyHostname == null) {
throw new SQLException(Tag.PRODUCT + " proxyHostname mus be set if proxyType is not DIRECT.");
}
int port = -1;
Proxy proxy = null;
if (proxyPort == null) {
throw new SQLException(Tag.PRODUCT + " proxyPort can not be null!");
}
try {
port = Integer.parseInt(proxyPort);
} catch (NumberFormatException e) {
throw new SQLException(Tag.PRODUCT + " Invalid proxy port. Port is not numeric: " + proxyPort);
}
if (!proxyType.equals(Type.HTTP.toString()) && !proxyType.equals(Type.SOCKS.toString())) {
throw new SQLException(Tag.PRODUCT + " Invalid proxyType. Must be: " + Type.HTTP.toString() + " or "
+ Type.SOCKS.toString() + ". proxyType ss: " + proxyType);
}
proxy = new Proxy(Type.valueOf(proxyType), new InetSocketAddress(proxyHostname, port));
return proxy;
}
/**
* Check that required values are not null.
*
* @param username
* @param password
* @param database
* @throws SQLException
*/
public static void checkNonNullValues(String username, String password, String database) throws SQLException {
if (username == null) {
throw new SQLException(Tag.PRODUCT + " user not set. Please provide a user.");
}
if (password == null) {
throw new SQLException(Tag.PRODUCT + " password not set. Please provide a password.");
}
if (database == null) {
throw new SQLException(Tag.PRODUCT + " database not set. Please provide a database.");
}
}
/**
* Check that required values are not null.
*
* @param username
* @param password
* @param database
* @param sessionId
* @throws SQLException
*/
public static void checkNonNullValues(String username, String password, String database, String sessionId)
throws SQLException {
if (username == null) {
throw new SQLException(Tag.PRODUCT + " user not set. Please provide a user.");
}
if (password == null && sessionId == null) {
throw new SQLException(
Tag.PRODUCT + " password or sessionId not set. Please provide a password or a sessionId.");
}
if (database == null) {
throw new SQLException(Tag.PRODUCT + " database not set. Please provide a database.");
}
}
public static Map getRequestProperties(Properties info) {
Objects.requireNonNull(info, "info cannot be null");
Set set = info.keySet();
Map requestProperties = new HashMap<>();
for (Object object : set) {
String key = (String) object;
if (key.startsWith(REQUEST_PROPERTY)) {
String mapKey = StringUtils.substringAfter(key, REQUEST_PROPERTY);
String value = info.getProperty(key);
requestProperties.put(mapKey, value);
}
}
return requestProperties;
}
/**
* @param info
* @return
* @throws SQLException
*/
public static ResultSetMetaDataPolicy getResultSetMetaDataPolicy(Properties info) throws SQLException {
String resultSetMetaDataPolicyStr = info.getProperty("resultSetMetaDataPolicy");
if (resultSetMetaDataPolicyStr == null) {
resultSetMetaDataPolicyStr = "on";
}
if (!resultSetMetaDataPolicyStr.equals(ResultSetMetaDataPolicy.on.toString())
&& !resultSetMetaDataPolicyStr.equals(ResultSetMetaDataPolicy.off.toString())) {
throw new SQLException("Invalid resultSetMetaDataPolicy: " + resultSetMetaDataPolicyStr
+ ". Possible values are \"on\", \"off\".");
}
ResultSetMetaDataPolicy resultSetMetaDataPolicy = null;
if (resultSetMetaDataPolicyStr.equals("on")) {
resultSetMetaDataPolicy = ResultSetMetaDataPolicy.on;
} else {
resultSetMetaDataPolicy = ResultSetMetaDataPolicy.off;
}
return resultSetMetaDataPolicy;
}
}