ServerConfiguration.java
/* Copyright (c) 2001-2024, The HSQL Development Group
* All rights reserved.
*
* 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 HSQL Development Group nor the names of its
* contributors may 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 HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* 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.hsqldb.server;
import java.net.InetAddress;
import org.hsqldb.lib.HashSet;
import org.hsqldb.lib.StringUtil;
import org.hsqldb.persist.HsqlProperties;
/*
* @todo: move to here from Server and WebServer the remaining extraneous code
* dealing primarily with reading/setting properties from files, etc.
*/
/**
* Assists with Server and WebServer configuration tasks.
*
* @author Campbell Burnet (campbell-burnet@users dot sourceforge.net)
* @version 2.2.7
* @since 1.7.2
*/
public final class ServerConfiguration implements ServerConstants {
private ServerConfiguration() {}
/**
* Retrieves the default port that a Server will try to use in the
* absence of an explicitly specified one, given the specified
* value for whether or not to use secure sockets.
*
* @param protocol the protocol specifier code of the Server
* @param isTls if true, retrieve the default port when using secure
* sockets, else the default port when using plain sockets
* @return the default port used in the absence of an explicit
* specification.
*
*/
public static int getDefaultPort(int protocol, boolean isTls) {
switch (protocol) {
case SC_PROTOCOL_HSQL : {
return isTls
? SC_DEFAULT_HSQLS_SERVER_PORT
: SC_DEFAULT_HSQL_SERVER_PORT;
}
case SC_PROTOCOL_HTTP : {
return isTls
? SC_DEFAULT_HTTPS_SERVER_PORT
: SC_DEFAULT_HTTP_SERVER_PORT;
}
case SC_PROTOCOL_BER : {
return isTls
? -1
: SC_DEFAULT_BER_SERVER_PORT;
}
default : {
return -1;
}
}
}
/**
* Retrieves a new HsqlProperties object, if possible, loaded from the
* specified file.
*
* @param protocol int
* @param path the file's path, without the .properties extension (which is
* added automatically)
* @param extension String
* @return a new properties object loaded from the specified file
*/
public static ServerProperties getPropertiesFromFile(
int protocol,
String path,
String extension) {
boolean result;
if (StringUtil.isEmpty(path)) {
return null;
}
ServerProperties p = new ServerProperties(protocol, path, extension);
try {
result = p.load();
} catch (Exception e) {
return null;
}
return result
? p
: null;
}
/**
* Retrieves an array of Strings naming the distinct, known to be valid local
* InetAddress names for this machine. The process is to collect and
* return the union of the following sets:
*
* <ol>
* <li> InetAddress.getAllByName(InetAddress.getLocalHost().getHostAddress())
* <li> InetAddress.getAllByName(InetAddress.getLocalHost().getHostName())
* <li> InetAddress.getAllByName(InetAddress.getByName(null).getHostAddress())
* <li> InetAddress.getAllByName(InetAddress.getByName(null).getHostName())
* <li> InetAddress.getByName("loopback").getHostAddress()
* <li> InetAddress.getByName("loopback").getHostname()
* </ol>
*
* @return the distinct, known to be valid local
* InetAddress names for this machine
*/
public static String[] listLocalInetAddressNames() {
InetAddress addr;
InetAddress[] addrs;
HashSet<String> set = new HashSet<String>();
try {
addr = InetAddress.getLocalHost();
addrs = InetAddress.getAllByName(addr.getHostAddress());
for (int i = 0; i < addrs.length; i++) {
set.add(addrs[i].getHostAddress());
set.add(addrs[i].getHostName());
}
addrs = InetAddress.getAllByName(addr.getHostName());
for (int i = 0; i < addrs.length; i++) {
set.add(addrs[i].getHostAddress());
set.add(addrs[i].getHostName());
}
} catch (Exception e) {}
try {
addr = InetAddress.getByName(null);
addrs = InetAddress.getAllByName(addr.getHostAddress());
for (int i = 0; i < addrs.length; i++) {
set.add(addrs[i].getHostAddress());
set.add(addrs[i].getHostName());
}
addrs = InetAddress.getAllByName(addr.getHostName());
for (int i = 0; i < addrs.length; i++) {
set.add(addrs[i].getHostAddress());
set.add(addrs[i].getHostName());
}
} catch (Exception e) {}
try {
set.add(InetAddress.getByName("loopback").getHostAddress());
set.add(InetAddress.getByName("loopback").getHostName());
} catch (Exception e) {}
String[] array = new String[set.size()];
set.toArray(array);
return array;
}
/**
* Retrieves a new default properties object for a server of the specified
* protocol
*
* @return a new default properties object
* @param protocol int
*/
public static ServerProperties newDefaultProperties(int protocol) {
ServerProperties p = new ServerProperties(protocol);
p.setProperty(
ServerProperties.sc_key_autorestart_server,
SC_DEFAULT_SERVER_AUTORESTART);
p.setProperty(ServerProperties.sc_key_address, SC_DEFAULT_ADDRESS);
p.setProperty(
ServerProperties.sc_key_no_system_exit,
SC_DEFAULT_NO_SYSTEM_EXIT);
p.setProperty(
ServerProperties.sc_key_max_databases,
SC_DEFAULT_MAX_DATABASES);
p.setProperty(ServerProperties.sc_key_silent, SC_DEFAULT_SILENT);
p.setProperty(ServerProperties.sc_key_tls, SC_DEFAULT_TLS);
p.setProperty(ServerProperties.sc_key_trace, SC_DEFAULT_TRACE);
p.setProperty(
ServerProperties.sc_key_web_default_page,
SC_DEFAULT_WEB_PAGE);
p.setProperty(ServerProperties.sc_key_web_root, SC_DEFAULT_WEB_ROOT);
// Purposefully do not set a default Port because the default is
// derived from TLS, which is runtime-configurable.
// Things work very well if we leave it unset here and use the
// getDefaultPort() method above to get the correct value.
return p;
}
/**
* Translates null or zero length value for address key to the
* special value ServerConstants.SC_DEFAULT_ADDRESS which causes
* ServerSockets to be constructed without specifying an InetAddress.
*
* @param p The properties object upon which to perform the translation
*/
public static void translateAddressProperty(HsqlProperties p) {
if (p == null) {
return;
}
String address = p.getProperty(ServerProperties.sc_key_address);
if (StringUtil.isEmpty(address)) {
p.setProperty(ServerProperties.sc_key_address, SC_DEFAULT_ADDRESS);
}
}
/**
* Translates the legacy default database form: database=...
* to the 1.7.2 form: database.0=...
*
* @param p The properties object upon which to perform the translation
*/
public static void translateDefaultDatabaseProperty(HsqlProperties p) {
if (p == null) {
return;
}
if (!p.isPropertyTrue(ServerProperties.sc_key_remote_open_db)) {
if (p.getProperty(ServerProperties.sc_key_database + "." + 0)
== null) {
String defaultdb = p.getProperty(
ServerProperties.sc_key_database);
if (defaultdb == null) {
defaultdb = SC_DEFAULT_DATABASE;
} else {
p.removeProperty(ServerProperties.sc_key_database);
}
p.setProperty(
ServerProperties.sc_key_database + ".0",
defaultdb);
p.setProperty(ServerProperties.sc_key_dbname + ".0", "");
}
if (p.getProperty(ServerProperties.sc_key_dbname + "." + 0)
== null) {
p.setProperty(ServerProperties.sc_key_dbname + ".0", "");
}
}
}
/**
* Translates unspecified no_system_exit property to false, the default
* typically required when a Server is started from the command line.
*
* @param p The properties object upon which to perform the translation
*/
public static void translateDefaultNoSystemExitProperty(HsqlProperties p) {
if (p == null) {
return;
}
p.setPropertyIfNotExists(
ServerProperties.sc_key_no_system_exit,
"false");
}
}