de.viadee.bpm.vPAV.RuntimeConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of viadeeProcessApplicationValidator Show documentation
The tool checks Camunda projects for consistency and discovers errors in process-driven applications. Called as a Maven plugin or JUnit test, it discovers esp. inconsistencies of a given BPMN model in the classpath and the sourcecode of an underlying java project, such as a delegate reference to a non-existing java class or a non-existing Spring bean.
There is a newer version: 3.0.8
Show newest version
/**
 * BSD 3-Clause License
 *
 * Copyright © 2019, viadee Unternehmensberatung AG
 * 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 copyright holder 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 THE COPYRIGHT HOLDER 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 de.viadee.bpm.vPAV;

import de.viadee.bpm.vPAV.config.model.Rule;
import de.viadee.bpm.vPAV.config.model.Setting;
import de.viadee.bpm.vPAV.constants.ConfigConstants;
import org.springframework.context.ApplicationContext;

import java.net.URL;
import java.net.URLClassLoader;
import java.util.*;
import java.util.logging.Logger;

public class RuntimeConfig {

	private static RuntimeConfig instance;

	private ApplicationContext ctx;

	private Map beanMap;

	private Map> activeRuleSet = new HashMap<>();

	private ClassLoader classLoader;

	private ResourceBundle resourceBundle;

	private boolean test = false; // TODO: Replace with parameterized method calls, to improve separation of test
									// and production code

	private static Logger logger = Logger.getLogger(RuntimeConfig.class.getName());

	private final String[] viadeeRules = { "XorConventionChecker", "TimerExpressionChecker", "JavaDelegateChecker",
			"NoScriptChecker", "NoExpressionChecker", "EmbeddedGroovyScriptChecker", "VersioningChecker",
			"DmnTaskChecker", "ProcessVariablesModelChecker", "ProcessVariablesNameConventionChecker",
			"TaskNamingConventionChecker", "ElementIdConventionChecker", "MessageEventChecker", "FieldInjectionChecker",
			"BoundaryErrorChecker", "ExtensionChecker", "OverlapChecker", "SignalEventChecker",
			"DataFlowChecker", "MessageCorrelationChecker", "CreateOutputHTML"};

	private ArrayList allActiveRules = new ArrayList<>();

	private RuntimeConfig() {
	}

	public static RuntimeConfig getInstance() {
		if (RuntimeConfig.instance == null) {
			RuntimeConfig.instance = new RuntimeConfig();
		}
		return RuntimeConfig.instance;
	}

	public String findBeanByName(String string) {
		if (string != null && !string.isEmpty() && beanMap != null && !beanMap.isEmpty()) {
			return beanMap.get(string);
		} else
			return null;
	}

	public void setBeanMapping(Map beanMap) {
		this.beanMap = beanMap;
	}

	public Map getBeanMapping() {
		return beanMap;
	}

	public void setClassLoader(ClassLoader classLoader) {
		this.classLoader = classLoader;
	}

	public ClassLoader getClassLoader() {
		return classLoader;
	}

	public boolean isTest() {
		return test;
	}

	public void setTest(boolean test) {
		this.test = test;
	}

	public ArrayList getActiveRules() {
		return allActiveRules;
	}

	public String[] getViadeeRules() {
		return viadeeRules;
	}

	public void addActiveRules(Map> rules) {
		for (Map.Entry> entry : rules.entrySet()) {
			for (Map.Entry ruleEntry : entry.getValue().entrySet()) {
				Rule rule = ruleEntry.getValue();
				if (rule.isActive() && !rule.getName().equals(ConfigConstants.HASPARENTRULESET)) {
					if (!activeRuleSet.containsKey(entry.getKey())) {
						activeRuleSet.put(entry.getKey(), new HashMap<>());
					}
					activeRuleSet.get(entry.getKey()).put(ruleEntry.getKey(), ruleEntry.getValue());
				}

				allActiveRules.add(entry.getKey());
			}
		}
	}

	public Map> getActiveRuleSet() {
		return activeRuleSet;
	}

	public void setApplicationContext(ApplicationContext ctx) {
		this.ctx = ctx;
	}

	public ApplicationContext getApplicationContext() {
		return ctx;
	}

	/**
	 * Retrieve locale from ruleSet. If locale can not be retrieved, use system
	 * locale
	 * 
	 * @param rules
	 *            RuleSet Rules from ruleset
	 */
	public void retrieveLocale(Map> rules) {
		try {
			// Todo don't allow definition of language in rule set in future versions
			final Rule rule = rules.get("language").get("language");
			final Map settings = rule.getSettings();
			if (settings.get("locale").getValue().equals("de")) {
				getResource("de_DE");
			} else if (settings.get("locale").getValue().equals("en")) {
				getResource("en_US");
			}
			logger.warning("Usage of 'language' rule is deprecated. Please use vpav.properties instead.");
		} catch (NullPointerException e) {
			if (ConfigConstants.getInstance().getLanguage().equals("de_DE")) {
				getResource("de_DE");
			} else {
				getResource("en_US");
			}
		}
	}

	/**
	 * Set base directory and set ResourceBundle
	 * 
	 * @param locale
	 *            Locale extracted from ruleSet or either default system locale
	 *            Localization
	 */
	public void getResource(final String locale) {
		setResourceBundle(fromClassLoader("messages_" + locale));
	}

	/**
	 * Retrieves ResourceBundle from base directy and returns it to RuntimeConfig
	 *
	 * @param bundleName
	 *            Bundle name for localization
	 * @return ResourceBundle
	 */
	private static ResourceBundle fromClassLoader(final String bundleName) {

		URL[] urls;
		URLClassLoader ucl;
		if (RuntimeConfig.getInstance().getClassLoader() instanceof URLClassLoader) {
			ucl = ((URLClassLoader) RuntimeConfig.getInstance().getClassLoader());
		} else {
			ucl = ((URLClassLoader) RuntimeConfig.getInstance().getClassLoader().getParent());
		}

		urls = ucl.getURLs();

		ClassLoader loader = new URLClassLoader(urls);

		return ResourceBundle.getBundle(bundleName, Locale.getDefault(), loader);
	}

	public ResourceBundle getResourceBundle() {
		return resourceBundle;
	}

	public void setResourceBundle(ResourceBundle resourceBundle) {
		this.resourceBundle = resourceBundle;
	}

}