Java tutorial
/* * TacTex - a power trading agent that competed in the Power Trading Agent Competition (Power TAC) www.powertac.org * Copyright (c) 2013-2016 Daniel Urieli and Peter Stone {urieli,pstone}@cs.utexas.edu * * * This file is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This file 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * * This file incorporates work covered by the following copyright and * permission notice: * * Copyright (c) 2011 by the original author * * 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 edu.utexas.cs.tactex.core; import java.io.File; import java.io.IOException; import java.util.Collection; import org.apache.commons.configuration.CompositeConfiguration; import org.apache.commons.configuration.Configuration; import org.apache.commons.configuration.ConfigurationException; import org.apache.commons.configuration.PropertiesConfiguration; import org.apache.commons.configuration.XMLConfiguration; import org.apache.log4j.Logger; import org.powertac.common.config.Configurator; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.core.io.Resource; import org.springframework.stereotype.Service; /** * @author jcollins */ @Service public class BrokerPropertiesService implements ApplicationContextAware { static private Logger log = Logger.getLogger(BrokerPropertiesService.class); private ApplicationContext context; private CompositeConfiguration config; private Configurator configurator; private boolean initialized = false; /** * Default constructor */ public BrokerPropertiesService() { super(); recycle(); } // test support void recycle() { // set up the config instance config = new CompositeConfiguration(); configurator = new Configurator(); initialized = false; } /** * Loads the properties from classpath, default config file, * and user-specified config file, just in case it's not already been * loaded. This is done when properties are first requested, to ensure * that the logger has been initialized. Because the CompositeConfiguration * treats its config sources in FIFO order, this should be called <i>after</i> * any user-specified config is loaded. */ void lazyInit() { // only do this once if (initialized) return; initialized = true; // find and load the default properties file log.debug("lazyInit"); try { File defaultProps = new File("broker.properties"); log.info("adding " + defaultProps.getName()); config.addConfiguration(new PropertiesConfiguration(defaultProps)); } catch (Exception e1) { log.warn("broker.properties not found: " + e1.toString()); } // set up the classpath props try { Resource[] xmlResources = context.getResources("classpath*:config/properties.xml"); for (Resource xml : xmlResources) { if (validXmlResource(xml)) { log.info("loading config from " + xml.getURI()); XMLConfiguration xconfig = new XMLConfiguration(); xconfig.load(xml.getInputStream()); config.addConfiguration(xconfig); } } Resource[] propResources = context.getResources("classpath*:config/*.properties"); for (Resource prop : propResources) { if (validPropResource(prop)) { if (null == prop) { log.error("Null resource"); } log.info("loading config from " + prop.getURI()); PropertiesConfiguration pconfig = new PropertiesConfiguration(); pconfig.load(prop.getInputStream()); config.addConfiguration(pconfig); } } } catch (ConfigurationException e) { log.error("Problem loading configuration: " + e.toString()); } catch (Exception e) { log.error("Error loading configuration: " + e.toString()); } // set up the configurator configurator.setConfiguration(config); } public void setUserConfig(File userConfig) { // then load the user-specified config try { PropertiesConfiguration pconfig = new PropertiesConfiguration(); pconfig.load(userConfig); config.addConfiguration(pconfig); log.debug("setUserConfig " + userConfig.getName()); } catch (ConfigurationException e) { log.error("Config error loading " + userConfig + ": " + e.toString()); } lazyInit(); } public void configureMe(Object target) { lazyInit(); configurator.configureSingleton(target); } public Collection<?> configureInstances(Class<?> target) { lazyInit(); return configurator.configureInstances(target); } public String getProperty(String name) { lazyInit(); return config.getString(name); } public String getProperty(String name, String defaultValue) { lazyInit(); return config.getString(name, defaultValue); } public Integer getIntegerProperty(String name, Integer defaultValue) { lazyInit(); return config.getInteger(name, defaultValue); } public Double getDoubleProperty(String name, Double defaultValue) { lazyInit(); return config.getDouble(name, defaultValue); } @Override public void setApplicationContext(ApplicationContext context) throws BeansException { this.context = context; } /** * Changes the value of a property (or adds a property). */ public void setProperty(String key, Object value) { lazyInit(); config.setProperty(key, value); } // -- valid configuration resources -- private String[] excludedPaths = { ".*/test-classes/.*", ".*/log4j.properties" }; private boolean validXmlResource(Resource xml) { try { log.info("Validating resource " + xml.getURI()); String path = xml.getURI().toString(); for (String regex : excludedPaths) { if (path.matches(regex)) { return false; } if (!xml.exists()) { log.warn("Resource " + xml.getURI() + " does not exist"); return false; } if (!xml.isReadable()) { log.warn("Resource " + xml.getURI() + " is not readable"); return false; } } return true; } catch (IOException e) { log.error("Should not happen: " + e.toString()); return false; } catch (Exception e) { log.error("Validation error " + e.toString()); e.printStackTrace(); return false; } } private boolean validPropResource(Resource prop) { return validXmlResource(prop); } // test support Configuration getConfig() { return config; } }