org.fabric3.fabric.runtime.bootstrap.SystemConfigLoader Maven / Gradle / Ivy
The newest version!
/*
* Fabric3
* Copyright (c) 2009-2015 Metaform Systems
*
* 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.
*
* Portions originally based on Apache Tuscany 2007
* licensed under the Apache 2.0 license.
*/
package org.fabric3.fabric.runtime.bootstrap;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.fabric3.api.host.Environment;
import org.fabric3.api.host.Fabric3Exception;
import org.fabric3.api.host.Names;
import org.fabric3.api.host.stream.Source;
import org.fabric3.api.host.stream.UrlSource;
import org.fabric3.api.model.type.RuntimeMode;
import org.fabric3.fabric.xml.DocumentLoader;
import org.fabric3.fabric.xml.DocumentLoaderImpl;
import org.oasisopen.sca.Constants;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
/**
* Loads the system configuration property for a runtime domain.
*/
public class SystemConfigLoader {
private static final URI DEFAULT_DOMAIN = URI.create("fabric3://domain");
private DocumentLoader loader;
public SystemConfigLoader() {
loader = new DocumentLoaderImpl();
}
/**
* Loads the system configuration value from a systemConfig.xml file or creates a default value if the file does not exist.
*
* @param configDirectory the directory where the file is located
* @return the loaded value
* @throws Fabric3Exception if an error parsing the file contents is encountered
*/
public Document loadSystemConfig(File configDirectory) throws Fabric3Exception {
File systemConfig = new File(configDirectory, "systemConfig.xml");
if (systemConfig.exists()) {
try {
URL url = systemConfig.toURI().toURL();
Source source = new UrlSource(url);
return loadSystemConfig(source);
} catch (MalformedURLException e) {
throw new Fabric3Exception(e);
}
}
return createDefaultSystemConfig();
}
/**
* Returns a configuration property value for the runtime domain from the given source.
*
* @param source the source to read
* @return the domain configuration property
* @throws Fabric3Exception if an error reading the source is encountered
*/
public Document loadSystemConfig(Source source) throws Fabric3Exception {
InputSource inputSource = new InputSource(source.openStream());
Document document = loader.load(inputSource, true);
// all properties have a root element, append the existing root to it. The existing root will be taken as a property .
Element oldRoot = document.getDocumentElement();
boolean hasNamespaces = oldRoot.getNamespaceURI() != null && !"".equals(oldRoot.getNamespaceURI());
Element newRoot = document.createElementNS(org.fabric3.api.Namespaces.F3, "values");
newRoot.setAttribute("xmlns:sca", Constants.SCA_NS);
document.removeChild(oldRoot);
document.appendChild(newRoot);
newRoot.appendChild(oldRoot);
if (!hasNamespaces) {
// System config did not specify namespaces, add them
// Note that namespaces are not added to attributes since the latter do not inherit the default namespace:
// http://www.w3.org/TR/REC-xml-names/#defaulting (the default namespace does not apply to attribute names)
// If namespaces were added to attributes, consistency would require users to manually add them to all attributes in a systemConfig
// that is namespace-aware and hence is not updated using DocumentLoader.addNamespace().
loader.addNamespace(document, oldRoot, org.fabric3.api.Namespaces.F3);
}
return document;
}
/**
* Creates a default configuration property value for the runtime domain.
*
* @return a document representing the configuration property
*/
public Document createDefaultSystemConfig() {
try {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
Document document = factory.newDocumentBuilder().newDocument();
Element root = document.createElement("values");
document.appendChild(root);
Element config = document.createElement("config");
root.appendChild(config);
return document;
} catch (ParserConfigurationException e) {
throw new AssertionError(e);
}
}
/**
* Returns the configured domain name the runtime should join. If not configured, the default domain name will be returned.
*
* @param systemConfig the system configuration
* @return the domain name
* @throws Fabric3Exception if there is an error parsing the domain name
*/
public URI parseDomainName(Document systemConfig) throws Fabric3Exception {
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("runtime");
if (nodes.getLength() == 1) {
Element node = (Element) nodes.item(0);
String name = node.getAttribute("domain");
if (name.length() > 0) {
try {
URI uri = new URI("fabric3://" + name);
if (uri.getHost() == null) {
throw new Fabric3Exception("Invalid domain name specified in system configuration. Domain names must be a valid URI host.");
}
return uri;
} catch (URISyntaxException e) {
throw new Fabric3Exception("Invalid domain name specified in system configuration", e);
}
} else {
return DEFAULT_DOMAIN;
}
} else if (nodes.getLength() == 0) {
return DEFAULT_DOMAIN;
}
throw new Fabric3Exception("Invalid system configuration: more than one element specified");
}
/**
* Returns the product name. If not configured, "Fabric3" will be returned.
*
* @param systemConfig the system configuration
* @return the product name
* @throws Fabric3Exception if there is an error parsing the domain name
*/
public String parseProductName(Document systemConfig) throws Fabric3Exception {
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("runtime");
if (nodes.getLength() == 1) {
Element node = (Element) nodes.item(0);
String name = node.getAttribute("product");
if (name.length() > 0) {
return name;
} else {
return "Fabric3";
}
} else if (nodes.getLength() == 0) {
return "Fabric3";
}
throw new Fabric3Exception("Invalid system configuration: more than one element specified");
}
public String parseZoneName(Document systemConfig, RuntimeMode mode) throws Fabric3Exception {
if (RuntimeMode.VM == mode) {
return Names.LOCAL_ZONE;
}
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("zoneName");
if (nodes.getLength() == 1) {
Element node = (Element) nodes.item(0);
String name = node.getTextContent();
if (name != null) {
name = name.trim();
}
return name;
} else if (nodes.getLength() == 0) {
return Names.DEFAULT_ZONE;
}
throw new Fabric3Exception("Invalid system configuration: more than one element specified");
}
/**
* Returns the configured runtime mode. If not configured, {@link RuntimeMode#VM} will be returned.
*
* @param systemConfig the system configuration
* @return the domain name
* @throws Fabric3Exception if there is an error parsing the domain name
*/
public RuntimeMode parseRuntimeMode(Document systemConfig) throws Fabric3Exception {
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("runtime");
if (nodes.getLength() == 1) {
Element node = (Element) nodes.item(0);
String name = node.getAttribute("mode");
if ("node".equalsIgnoreCase(name)) {
return RuntimeMode.NODE;
}
}
return RuntimeMode.VM;
}
/**
* Returns the runtime environment. If one is not explicitly configured, the default {@link Environment#PRODUCTION} will be returned.
*
* @param systemConfig the system configuration
* @return the parsed runtime environment
*/
public String parseEnvironment(Document systemConfig) {
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("runtime");
if (nodes.getLength() == 1) {
Element node = (Element) nodes.item(0);
String environment = node.getAttribute("environment");
if (environment.length() > 0) {
return environment;
}
}
return Environment.PRODUCTION;
}
/**
* Returns configured deployment directories or an empty collection.
*
* @param systemConfig the system configuration
* @return the deployment directories
*/
public List parseDeployDirectories(Document systemConfig) {
List files = new ArrayList<>();
Element root = systemConfig.getDocumentElement();
NodeList nodes = root.getElementsByTagName("deploy.directory");
for (int i = 0; i < nodes.getLength(); i++) {
Element element = (Element) nodes.item(i);
File file = new File(element.getTextContent());
files.add(file);
}
return files;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy