org.teknux.jettybootstrap.configuration.PropertiesJettyConfiguration Maven / Gradle / Ivy
/*******************************************************************************
* (C) Copyright 2014 Teknux.org (http://teknux.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.
*
* Contributors:
* "Pierre PINON"
* "Francois EYL"
* "Laurent MARCHAL"
*
*******************************************************************************/
package org.teknux.jettybootstrap.configuration;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.teknux.jettybootstrap.utils.PropertiesUtil;
/**
* {@link IJettyConfiguration} implementation based on properties. By default (empty constructor), system properties are used. In addition (lower priority), a {@link Properties}
* object can be passed to first look into it for configuration values.
*
* Partial configuration is supported since this is an override of defaults.
*
* @author "Francois EYL"
*/
public class PropertiesJettyConfiguration extends JettyConfiguration {
public static final String CONNECTOR_SEPARATOR = ",";
public static final String KEY_AUTO_JOIN_ON_START = "autoJoinOnStart";
public static final String KEY_MAX_THREADS = "maxThreads";
public static final String KEY_STOP_AT_SHUTDOWN = "stopAtShutdown";
public static final String KEY_STOP_TIMEOUT = "stopTimeout";
public static final String KEY_IDLE_TIMEOUT = "idleTimeout";
public static final String KEY_HOST = "host";
public static final String KEY_PORT = "port";
public static final String KEY_SSL_PORT = "sslPort";
public static final String KEY_CONNECTORS = "connectors";
public static final String KEY_REDIRECT_WEBAPPS_ON_HTTPS = "redirectWebAppsOnHttpsConnector";
public static final String KEY_SSL_PRIVATEKEY_FORMAT = "sslPrivateKeyFormat";
public static final String KEY_SSL_PRIVATEKEY_PATH = "sslPrivateKeyPath";
public static final String KEY_SSL_PRIVATEKEY_PASSWORD = "sslPrivateKeyPassword";
public static final String KEY_SSL_CERTIFICATE_FORMAT = "sslCertificateFormat";
public static final String KEY_SSL_CERTIFICATE_PATH = "sslCertificatePath";
public static final String KEY_SSL_CERTIFICATE_PASSWORD = "sslCertificatePassword";
public static final String KEY_SSL_KEYSTORE_PATH = "sslKeystorePath";
public static final String KEY_SSL_KEYSTORE_DOMAINNAME = "sslKeyStoreDomainName";
public static final String KEY_SSL_KEYSTORE_ALIAS = "sslKeyStoreAlias";
public static final String KEY_SSL_KEYSTORE_PASSWORD = "sslKeystorePassword";
public static final String KEY_SSL_KEYSTORE_ALGORITHM = "sslKeyStoreAlgorithm";
public static final String KEY_SSL_KEYSTORE_SIGNATURE_ALGORITHM = "sslKeyStoreSignatureAlgorithm";
public static final String KEY_SSL_KEYSTORE_RDN_OU_VALUE = "sslKeyStoreRdnOuValue";
public static final String KEY_SSL_KEYSTORE_RDN_O_VALUE = "sslKeyStoreRdnOValue";
public static final String KEY_SSL_KEYSTORE_DATE_NOT_BEFORE_NUMBER_OF_DAYS = "sslKeyStoreDateNotBeforeNumberOfDays";
public static final String KEY_SSL_KEYSTORE_DATE_NOT_AFTER_NUMBER_OF_DAYS = "sslKeyStoreDateNotAfterNumberOfDays";
public static final String KEY_TEMP_DIR = "tempDirectory";
public static final String KEY_PERSIST_APP_TEMP_DIR = "persistAppTempDirectories";
public static final String KEY_CLEAN_TEMP_DIR = "cleanTempDir";
public static final String KEY_PARENT_LOADER_PRIORITY = "parentLoaderPriority";
public static final String KEY_THROW_IF_STARTUP_EXCEPTION = "throwIfStartupException";
public static final String KEY_MAX_INACTIVE_INTERVAL = "maxInactiveInterval";
/**
* Basic constructor. Only system properties are used to map jetty configuration.
*/
public PropertiesJettyConfiguration() {
this(null);
}
/**
* First load the given {@link Properties} to map jetty configuration, system properties are applied after. This means system properties have higher priorities that the
* provided ones.
*
* @param properties
* Properties
*/
public PropertiesJettyConfiguration(Properties properties) {
this(properties, false);
}
/**
* First load the given {@link Properties} to map jetty configuration, system properties are applied after. This means system properties have higher priorities that the
* provided ones.
*
* @param properties
* Properties
* @param ignoreSystemProperties
* boolean
*/
public PropertiesJettyConfiguration(Properties properties, boolean ignoreSystemProperties) {
if (properties != null) {
//load given properties first
loadProperties(properties);
}
if (!ignoreSystemProperties) {
//load system properties
loadProperties(System.getProperties());
}
}
private void loadProperties(Properties properties) {
Boolean autoJoin = PropertiesUtil.parseBoolean(properties, KEY_AUTO_JOIN_ON_START);
if (autoJoin != null) {
setAutoJoinOnStart(autoJoin);
}
Integer maxThreads = PropertiesUtil.parseInt(properties, KEY_MAX_THREADS);
if (maxThreads != null) {
setMaxThreads(maxThreads);
}
Boolean stopAtShutdown = PropertiesUtil.parseBoolean(properties, KEY_STOP_AT_SHUTDOWN);
if (stopAtShutdown != null) {
setStopAtShutdown(stopAtShutdown);
}
Long stopTimeout = PropertiesUtil.parseLong(properties, KEY_STOP_TIMEOUT);
if (stopTimeout != null) {
setStopTimeout(stopTimeout);
}
Long idleTimeout = PropertiesUtil.parseLong(properties, KEY_IDLE_TIMEOUT);
if (idleTimeout != null) {
setIdleTimeout(idleTimeout);
}
String host = properties.getProperty(KEY_HOST);
if (host != null) {
setHost(host);
}
Integer port = PropertiesUtil.parseInt(properties, KEY_PORT);
if (port != null) {
setPort(port);
}
Integer sslPort = PropertiesUtil.parseInt(properties, KEY_SSL_PORT);
if (sslPort != null) {
setSslPort(sslPort);
}
JettyConnector[] connectors = parseConnectors(PropertiesUtil.parseArray(properties, KEY_CONNECTORS, CONNECTOR_SEPARATOR));
if (connectors != null) {
setJettyConnectors(connectors);
}
Boolean redirectOnSSL = PropertiesUtil.parseBoolean(properties, KEY_REDIRECT_WEBAPPS_ON_HTTPS);
if (redirectOnSSL != null) {
setRedirectWebAppsOnHttpsConnector(redirectOnSSL);
}
JettySslFileFormat sslPrivateKeyFormat = JettySslFileFormat.getByName(properties.getProperty(KEY_SSL_PRIVATEKEY_FORMAT));
if (sslPrivateKeyFormat != null) {
setSslPrivateKeyFormat(sslPrivateKeyFormat);
}
String sslPrivateKeyPath = properties.getProperty(KEY_SSL_PRIVATEKEY_PATH);
if (sslPrivateKeyPath != null) {
setSslPrivateKeyPath(sslPrivateKeyPath);
}
String sslPrivateKeyPassword = properties.getProperty(KEY_SSL_PRIVATEKEY_PASSWORD);
if (sslPrivateKeyPassword != null) {
setSslPrivateKeyPassword(sslPrivateKeyPassword);
}
JettySslFileFormat sslCertificateFormat = JettySslFileFormat.getByName(properties.getProperty(KEY_SSL_CERTIFICATE_FORMAT));
if (sslCertificateFormat != null) {
setSslCertificateFormat(sslCertificateFormat);
}
String sslCertificatePath = properties.getProperty(KEY_SSL_CERTIFICATE_PATH);
if (sslCertificatePath != null) {
setSslCertificatePath(sslCertificatePath);
}
String sslCertificatePassword = properties.getProperty(KEY_SSL_CERTIFICATE_PASSWORD);
if (sslCertificatePassword != null) {
setSslCertificatePassword(sslCertificatePassword);
}
String sslKeystorePath = properties.getProperty(KEY_SSL_KEYSTORE_PATH);
if (sslKeystorePath != null) {
setSslKeyStorePath(sslKeystorePath);
}
String sslKeystoreDomainName = properties.getProperty(KEY_SSL_KEYSTORE_DOMAINNAME);
if (sslKeystoreDomainName != null) {
setSslKeyStoreDomainName(sslKeystoreDomainName);
}
String sslKeystoreAlias = properties.getProperty(KEY_SSL_KEYSTORE_ALIAS);
if (sslKeystoreAlias != null) {
setSslKeyStoreAlias(sslKeystoreAlias);
}
String sslKeystorePassword = properties.getProperty(KEY_SSL_KEYSTORE_PASSWORD);
if (sslKeystorePassword != null) {
setSslKeyStorePassword(sslKeystorePassword);
}
String sslKeystoreAlgorithm = properties.getProperty(KEY_SSL_KEYSTORE_ALGORITHM);
if (sslKeystoreAlgorithm != null) {
setSslKeyStoreAlgorithm(sslKeystoreAlgorithm);
}
String sslKeystoreSignatureAlgorithm = properties.getProperty(KEY_SSL_KEYSTORE_SIGNATURE_ALGORITHM);
if (sslKeystoreSignatureAlgorithm != null) {
setSslKeyStoreSignatureAlgorithm(sslKeystoreSignatureAlgorithm);
}
String sslKeystoreRdnOuValue = properties.getProperty(KEY_SSL_KEYSTORE_RDN_OU_VALUE);
if (sslKeystoreRdnOuValue != null) {
setSslKeyStoreRdnOuValue(sslKeystoreRdnOuValue);
}
String sslKeystoreRdnOValue = properties.getProperty(KEY_SSL_KEYSTORE_RDN_O_VALUE);
if (sslKeystoreRdnOValue != null) {
setSslKeyStoreRdnOValue(sslKeystoreRdnOValue);
}
Integer sslKeyStoreDateNotBeforeNumberOfDays = PropertiesUtil.parseInt(properties, KEY_SSL_KEYSTORE_DATE_NOT_BEFORE_NUMBER_OF_DAYS);
if (sslKeyStoreDateNotBeforeNumberOfDays != null) {
setSslKeyStoreDateNotBeforeNumberOfDays(sslKeyStoreDateNotBeforeNumberOfDays);
}
Integer sslKeyStoreDateNotAfterNumberOfDays = PropertiesUtil.parseInt(properties, KEY_SSL_KEYSTORE_DATE_NOT_AFTER_NUMBER_OF_DAYS);
if (sslKeyStoreDateNotAfterNumberOfDays != null) {
setSslKeyStoreDateNotAfterNumberOfDays(sslKeyStoreDateNotAfterNumberOfDays);
}
String tempDir = properties.getProperty(KEY_TEMP_DIR);
if (tempDir != null) {
setTempDirectory(new File(tempDir));
}
Boolean persistAppTempDir = PropertiesUtil.parseBoolean(properties, KEY_PERSIST_APP_TEMP_DIR);
if (persistAppTempDir != null) {
setPersistAppTempDirectories(persistAppTempDir);
}
Boolean cleanTempDir = PropertiesUtil.parseBoolean(properties, KEY_CLEAN_TEMP_DIR);
if (cleanTempDir != null) {
setCleanTempDir(cleanTempDir);
}
Boolean parentLoaderPriority = PropertiesUtil.parseBoolean(properties, KEY_PARENT_LOADER_PRIORITY);
if (parentLoaderPriority != null) {
setParentLoaderPriority(parentLoaderPriority);
}
Boolean throwIfStartupException = PropertiesUtil.parseBoolean(properties, KEY_THROW_IF_STARTUP_EXCEPTION);
if (throwIfStartupException != null) {
setThrowIfStartupException(throwIfStartupException);
}
Integer maxInactiveInterval = PropertiesUtil.parseInt(properties, KEY_MAX_INACTIVE_INTERVAL);
if (maxInactiveInterval != null) {
setMaxInactiveInterval(maxInactiveInterval);
}
}
/**
* Parse the given array of String and return an array of {@link JettyConnector}. Invalid entry from input array are ignored, returns null when no value match from
* input array.
*
* @param connectors
* Connector Array
* @return array of {@link JettyConnector} null in case nothing match.
*/
public static JettyConnector[] parseConnectors(String[] connectors) {
if (connectors == null) {
return null;
}
List array = new ArrayList();
for (String coonectorString : connectors) {
try {
array.add(JettyConnector.valueOf(coonectorString));
} catch (IllegalArgumentException e) {
//nothing to do here
}
}
return !array.isEmpty() ? array.toArray(new JettyConnector[array.size()]) : null;
}
}