path: root/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/ServerConfiguration.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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 org.apache.qpid.server.configuration;

import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Locale;
import java.util.Map.Entry;

import org.apache.commons.configuration.CompositeConfiguration;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.ConfigurationFactory;
import org.apache.commons.configuration.SystemConfiguration;
import org.apache.commons.configuration.XMLConfiguration;
import org.apache.qpid.server.configuration.management.ConfigurationManagementMBean;
import org.apache.qpid.server.registry.ApplicationRegistry;
import org.apache.qpid.server.virtualhost.VirtualHost;
import org.apache.qpid.server.virtualhost.VirtualHostRegistry;
import org.apache.qpid.transport.NetworkDriverConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import sun.misc.Signal;
import sun.misc.SignalHandler;

public class ServerConfiguration implements SignalHandler
{

    private Configuration _config;

    // Default Configuration values
    //todo make these all public, to make validation of configuration easier.
    public static final int DEFAULT_BUFFER_READ_LIMIT_SIZE = 262144;
    public static final int DEFAULT_BUFFER_WRITE_LIMIT_SIZE = 262144;
    public static final boolean DEFAULT_BROKER_CONNECTOR_PROTECTIO_ENABLED = false;
    public static final String DEFAULT_STATUS_UPDATES = "on";

    private static final int DEFAULT_FRAME_SIZE = 65536;
    private static final int DEFAULT_PORT = 5672;
    private static final int DEFAUL_SSL_PORT = 8672;
    private static final long DEFAULT_HOUSEKEEPING_PERIOD = 30000L;
    private static final int DEFAULT_JMXPORT = 8999;

    private static int _jmxPort = DEFAULT_JMXPORT;

    private Map<String, VirtualHostConfiguration> _virtualHosts = new HashMap<String, VirtualHostConfiguration>();
    private SecurityConfiguration _securityConfiguration = null;

    private File _configFile;

    private Logger _log = LoggerFactory.getLogger(this.getClass());

    private ConfigurationManagementMBean _mbean;


    // Map of environment variables to config items
    private static final Map<String, String> envVarMap = new HashMap<String, String>();

    // Configuration values to be read from the configuration file
    //todo Move all properties to static values to ensure system testing can be performed.
    public static final String CONNECTOR_PROTECTIO_ENABLED = "connector.protectio.enabled";
    public static final String CONNECTOR_PROTECTIO_READ_BUFFER_LIMIT_SIZE = "connector.protectio.readBufferLimitSize";
    public static final String CONNECTOR_PROTECTIO_WRITE_BUFFER_LIMIT_SIZE = "connector.protectio.writeBufferLimitSize";
    public static final String STATUS_UPDATES = "status-updates";
    public static final String ADVANCED_LOCALE = "advanced.locale";

    {
        envVarMap.put("QPID_PORT", "connector.port");
        envVarMap.put("QPID_ENABLEDIRECTBUFFERS", "advanced.enableDirectBuffers");
        envVarMap.put("QPID_SSLPORT", "connector.ssl.port");
        envVarMap.put("QPID_NIO", "connector.qpidnio");
        envVarMap.put("QPID_WRITEBIASED", "advanced.useWriteBiasedPool");
        envVarMap.put("QPID_JMXPORT", "management.jmxport");
        envVarMap.put("QPID_FRAMESIZE", "advanced.framesize");
        envVarMap.put("QPID_MSGAUTH", "security.msg-auth");
        envVarMap.put("QPID_AUTOREGISTER", "auto_register");
        envVarMap.put("QPID_MANAGEMENTENABLED", "management.enabled");
        envVarMap.put("QPID_HEARTBEATDELAY", "heartbeat.delay");
        envVarMap.put("QPID_HEARTBEATTIMEOUTFACTOR", "heartbeat.timeoutFactor");
        envVarMap.put("QPID_MAXIMUMMESSAGEAGE", "maximumMessageAge");
        envVarMap.put("QPID_MAXIMUMMESSAGECOUNT", "maximumMessageCount");
        envVarMap.put("QPID_MAXIMUMQUEUEDEPTH", "maximumQueueDepth");
        envVarMap.put("QPID_MAXIMUMMESSAGESIZE", "maximumMessageSize");
        envVarMap.put("QPID_MINIMUMALERTREPEATGAP", "minimumAlertRepeatGap");
        envVarMap.put("QPID_SOCKETRECEIVEBUFFER", "connector.socketReceiveBuffer");
        envVarMap.put("QPID_SOCKETWRITEBUFFER", "connector.socketWriteBuffer");
        envVarMap.put("QPID_TCPNODELAY", "connector.tcpNoDelay");
        envVarMap.put("QPID_ENABLEPOOLEDALLOCATOR", "advanced.enablePooledAllocator");
        envVarMap.put("QPID_STATUS-UPDATES", "status-updates");
    }

    public ServerConfiguration(File configurationURL) throws ConfigurationException
    {
        this(parseConfig(configurationURL));
        _configFile = configurationURL;
        try
        {
            Signal sig = new sun.misc.Signal("HUP");
            sun.misc.Signal.handle(sig, this);
        }
        catch (IllegalArgumentException e)
        {
            // We're on something that doesn't handle SIGHUP, how sad, Windows. 
        }
    }

    public ServerConfiguration(Configuration conf) throws ConfigurationException
    {
        setConfig(conf);

        substituteEnvironmentVariables();

        _jmxPort = getConfig().getInt("management.jmxport", 8999);
        _securityConfiguration = new SecurityConfiguration(conf.subset("security"));

        setupVirtualHosts(conf);

    }

    private void setupVirtualHosts(Configuration conf) throws ConfigurationException
    {
        List vhosts = conf.getList("virtualhosts");
        Iterator i = vhosts.iterator();
        while (i.hasNext())
        {
            Object thing = i.next();
            if (thing instanceof String)
            {
                //Open the Virtualhost.xml file and copy values in to main config
                XMLConfiguration vhostConfiguration = new XMLConfiguration((String) thing);
                Iterator keys = vhostConfiguration.getKeys();
                while (keys.hasNext())
                {
                    String key = (String) keys.next();
                    conf.setProperty("virtualhosts." + key, vhostConfiguration.getProperty(key));
                }
            }
        }

        List hosts = conf.getList("virtualhosts.virtualhost.name");
        for (int j = 0; j < hosts.size(); j++)
        {
            String name = (String) hosts.get(j);
            // Add the keys of the virtual host to the main config then bail out

            VirtualHostConfiguration vhostConfig = new VirtualHostConfiguration(name, conf.subset("virtualhosts.virtualhost." + name));
            _virtualHosts.put(vhostConfig.getName(), vhostConfig);
        }

    }

    private void substituteEnvironmentVariables()
    {
        for (Entry<String, String> var : envVarMap.entrySet())
        {
            String val = System.getenv(var.getKey());
            if (val != null)
            {
                getConfig().setProperty(var.getValue(), val);
            }
        }
    }

    private final static Configuration parseConfig(File file) throws ConfigurationException
    {
        ConfigurationFactory factory = new ConfigurationFactory();
        factory.setConfigurationFileName(file.getAbsolutePath());
        Configuration conf = factory.getConfiguration();
        Iterator keys = conf.getKeys();
        if (!keys.hasNext())
        {
            keys = null;
            conf = flatConfig(file);
        }
        return conf;
    }

    /**
     * Check the configuration file to see if status updates are enabled.
     * @return true if status updates are enabled
     */
    public boolean getStatusUpdatesEnabled()
    {
        // Retrieve the setting from configuration but default to on.
        String value = getConfig().getString(STATUS_UPDATES, DEFAULT_STATUS_UPDATES);

        return value.equalsIgnoreCase("on");
    }

    /**
     * The currently defined {@see Locale} for this broker
     * @return the configuration defined locale
     */
    public Locale getLocale()
    {

        String localeString = getConfig().getString(ADVANCED_LOCALE);
        // Expecting locale of format langauge_country_variant

        // If the configuration does not have a defined locale use the JVM default 
        if (localeString == null)
        {
            return Locale.getDefault();
        }

        String[] parts = localeString.split("_");

        Locale locale;
        switch (parts.length)
        {
            case 1:
                locale = new Locale(localeString);
                break;
            case 2:
                locale = new Locale(parts[0], parts[1]);
                break;
            default:
                String variant = parts[2];
                // If we have a variant such as the Java doc suggests for Spanish
                // Traditional_WIN we may end up with more than 3 parts on a
                // split with '_'. So we should recombine the variant.
                if (parts.length > 3)
                {
                    for (int index = 3; index < parts.length; index++)
                    {
                        variant = variant + "_" + parts[index];
                    }
                }

                locale = new Locale(parts[0], parts[1], variant);
        }

        return locale;
    }

    // Our configuration class needs to make the interpolate method
    // public so it can be called below from the config method.
    public static class MyConfiguration extends CompositeConfiguration
    {
        public String interpolate(String obj)
        {
            return super.interpolate(obj);
        }
    }

    public final static Configuration flatConfig(File file) throws ConfigurationException
    {
        // We have to override the interpolate methods so that
        // interpolation takes place accross the entirety of the
        // composite configuration. Without doing this each
        // configuration object only interpolates variables defined
        // inside itself.
        final MyConfiguration conf = new MyConfiguration();
        conf.addConfiguration(new SystemConfiguration()
        {
            protected String interpolate(String o)
            {
                return conf.interpolate(o);
            }
        });
        conf.addConfiguration(new XMLConfiguration(file)
        {
            protected String interpolate(String o)
            {
                return conf.interpolate(o);
            }
        });
        return conf;
    }

    @Override
    public void handle(Signal arg0)
    {
        try
        {
            reparseConfigFile();
        }
        catch (ConfigurationException e)
        {
             _log.error("Could not reload configuration file", e);
        }
    }

    public void reparseConfigFile() throws ConfigurationException
    {
        if (_configFile != null)
        {
            Configuration newConfig = parseConfig(_configFile);
            _securityConfiguration = new SecurityConfiguration(newConfig.subset("security"));
            ApplicationRegistry.getInstance().getAccessManager().configurePlugins(_securityConfiguration);

            VirtualHostRegistry vhostRegistry = ApplicationRegistry.getInstance().getVirtualHostRegistry();
            for (String hostname : _virtualHosts.keySet())
            {
                VirtualHost vhost = vhostRegistry.getVirtualHost(hostname);
                SecurityConfiguration hostSecurityConfig = new SecurityConfiguration(newConfig.subset("virtualhosts.virtualhost."+hostname+".security"));
                vhost.getAccessManager().configureHostPlugins(hostSecurityConfig);
            }
        }
    }

    public void setConfig(Configuration _config)
    {
        this._config = _config;
    }

    public Configuration getConfig()
    {
        return _config;
    }

    public String getQpidWork()
    {
        return System.getProperty("QPID_WORK", System.getProperty("java.io.tmpdir"));
    }

    public void setJMXManagementPort(int mport)
    {
        _jmxPort = mport;
    }

    public int getJMXManagementPort()
    {
        return _jmxPort;
    }

    public boolean getPlatformMbeanserver()
    {
        return getConfig().getBoolean("management.platform-mbeanserver", true);
    }

    public String[] getVirtualHosts()
    {
        return _virtualHosts.keySet().toArray(new String[_virtualHosts.size()]);
    }

    public String getPluginDirectory()
    {
        return getConfig().getString("plugin-directory");
    }

    public VirtualHostConfiguration getVirtualHostConfig(String name)
    {
        return _virtualHosts.get(name);
    }

    public List<String> getPrincipalDatabaseNames()
    {
        return getConfig().getList("security.principal-databases.principal-database.name");
    }

    public List<String> getPrincipalDatabaseClass()
    {
        return getConfig().getList("security.principal-databases.principal-database.class");
    }

    public List<String> getPrincipalDatabaseAttributeNames(int index)
    {
        String name = "security.principal-databases.principal-database(" + index + ")." + "attributes.attribute.name";
        return getConfig().getList(name);
    }

    public List<String> getPrincipalDatabaseAttributeValues(int index)
    {
        String name = "security.principal-databases.principal-database(" + index + ")." + "attributes.attribute.value";
        return getConfig().getList(name);
    }

    public List<String> getManagementPrincipalDBs()
    {
        return getConfig().getList("security.jmx.principal-database");
    }

    public List<String> getManagementAccessList()
    {
        return getConfig().getList("security.jmx.access");
    }

    public int getFrameSize()
    {
        return getConfig().getInt("advanced.framesize", DEFAULT_FRAME_SIZE);
    }

    public boolean getProtectIOEnabled()
    {
        return getConfig().getBoolean(CONNECTOR_PROTECTIO_ENABLED, DEFAULT_BROKER_CONNECTOR_PROTECTIO_ENABLED);
    }

    public int getBufferReadLimit()
    {
        return getConfig().getInt(CONNECTOR_PROTECTIO_READ_BUFFER_LIMIT_SIZE, DEFAULT_BUFFER_READ_LIMIT_SIZE);
    }

    public int getBufferWriteLimit()
    {
        return getConfig().getInt(CONNECTOR_PROTECTIO_WRITE_BUFFER_LIMIT_SIZE, DEFAULT_BUFFER_WRITE_LIMIT_SIZE);
    }

    public boolean getSynchedClocks()
    {
        return getConfig().getBoolean("advanced.synced-clocks", false);
    }

    public boolean getMsgAuth()
    {
        return getConfig().getBoolean("security.msg-auth", false);
    }

    public String getJMXPrincipalDatabase()
    {
        return getConfig().getString("security.jmx.principal-database");
    }

    public String getManagementKeyStorePath()
    {
        return getConfig().getString("management.ssl.keyStorePath", null);
    }

    public boolean getManagementSSLEnabled()
    {
        return getConfig().getBoolean("management.ssl.enabled", true);
    }

    public String getManagementKeyStorePassword()
    {
        return getConfig().getString("management.ssl.keyStorePassword");
    }

    public SecurityConfiguration getSecurityConfiguration()
    {
        return _securityConfiguration;
    }

    public boolean getQueueAutoRegister()
    {
        return getConfig().getBoolean("queue.auto_register", true);
    }

    public boolean getManagementEnabled()
    {
        return getConfig().getBoolean("management.enabled", true);
    }

    public void setManagementEnabled(boolean enabled)
    {
        getConfig().setProperty("management.enabled", enabled);
    }

    public int getHeartBeatDelay()
    {
        return getConfig().getInt("heartbeat.delay", 5);
    }

    public double getHeartBeatTimeout()
    {
        return getConfig().getDouble("heartbeat.timeoutFactor", 2.0);
    }

    public int getDeliveryPoolSize()
    {
        return getConfig().getInt("delivery.poolsize", 0);
    }

    public long getMaximumMessageAge()
    {
        return getConfig().getLong("maximumMessageAge", 0);
    }

    public long getMaximumMessageCount()
    {
        return getConfig().getLong("maximumMessageCount", 0);
    }

    public long getMaximumQueueDepth()
    {
        return getConfig().getLong("maximumQueueDepth", 0);
    }

    public long getMaximumMessageSize()
    {
        return getConfig().getLong("maximumMessageSize", 0);
    }

    public long getMinimumAlertRepeatGap()
    {
        return getConfig().getLong("minimumAlertRepeatGap", 0);
    }

    public int getProcessors()
    {
        return getConfig().getInt("connector.processors", 4);
    }

    public int getPort()
    {
        return getConfig().getInt("connector.port", DEFAULT_PORT);
    }

    public String getBind()
    {
        return getConfig().getString("connector.bind", "wildcard");
    }

    public int getReceiveBufferSize()
    {
        return getConfig().getInt("connector.socketReceiveBuffer", 32767);
    }

    public int getWriteBufferSize()
    {
        return getConfig().getInt("connector.socketWriteBuffer", 32767);
    }

    public boolean getTcpNoDelay()
    {
        return getConfig().getBoolean("connector.tcpNoDelay", true);
    }

    public boolean getEnableExecutorPool()
    {
        return getConfig().getBoolean("advanced.filterchain[@enableExecutorPool]", false);
    }

    public boolean getEnablePooledAllocator()
    {
        return getConfig().getBoolean("advanced.enablePooledAllocator", false);
    }

    public boolean getEnableDirectBuffers()
    {
        return getConfig().getBoolean("advanced.enableDirectBuffers", false);
    }

    public boolean getEnableSSL()
    {
        return getConfig().getBoolean("connector.ssl.enabled", false);
    }

    public boolean getSSLOnly()
    {
        return getConfig().getBoolean("connector.ssl.sslOnly", false);
    }

    public int getSSLPort()
    {
        return getConfig().getInt("connector.ssl.port", DEFAUL_SSL_PORT);
    }

    public String getKeystorePath()
    {
        return getConfig().getString("connector.ssl.keystorePath", "none");
    }

    public String getKeystorePassword()
    {
        return getConfig().getString("connector.ssl.keystorePassword", "none");
    }

    public String getCertType()
    {
        return getConfig().getString("connector.ssl.certType", "SunX509");
    }

    public boolean getQpidNIO()
    {
        return getConfig().getBoolean("connector.qpidnio", false);
    }

    public boolean getUseBiasedWrites()
    {
        return getConfig().getBoolean("advanced.useWriteBiasedPool", false);
    }

    public String getDefaultVirtualHost()
    {
        return getConfig().getString("virtualhosts.default");
    }

    public void setHousekeepingExpiredMessageCheckPeriod(long value)
    {
        getConfig().setProperty("housekeeping.expiredMessageCheckPeriod", value);
    }

    public long getHousekeepingCheckPeriod()
    {
        return getConfig().getLong("housekeeping.checkPeriod",
                   getConfig().getLong("housekeeping.expiredMessageCheckPeriod",
                           DEFAULT_HOUSEKEEPING_PERIOD));
    }

    public NetworkDriverConfiguration getNetworkConfiguration()
    {
        return new NetworkDriverConfiguration()
        {
            
            public Integer getTrafficClass()
            {
                return null;
            }
            
            public Boolean getTcpNoDelay()
            {
                // Can't call parent getTcpNoDelay since it just calls this one
                return getConfig().getBoolean("connector.tcpNoDelay", true);
            }
            
            public Integer getSoTimeout()
            {
                return null;
            }
            
            public Integer getSoLinger()
            {
                return null;
            }
            
            public Integer getSendBufferSize()
            {
                return getBufferWriteLimit();
            }
            
            public Boolean getReuseAddress()
            {
                return null;
            }
            
            public Integer getReceiveBufferSize()
            {
                return getBufferReadLimit();
            }
            
            public Boolean getOOBInline()
            {
                return null;
            }
            
            public Boolean getKeepAlive()
            {
                return null;
            }
        };
    }
}