org.fabric3.introspection.xml.composite.IncludeLoader Maven / Gradle / Ivy
/*
* Fabric3
* Copyright (c) 2009-2013 Metaform Systems
*
* Fabric3 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, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 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 Fabric3.
* If not, see {
private static final QName INCLUDE = new QName(Constants.SCA_NS, "include");
private MetaDataStore store;
/**
* Constructor used during bootstrap.
*
* @param registry the loader registry
*/
public IncludeLoader(LoaderRegistry registry) {
this(registry, null);
}
/**
* Constructor.
*
* @param registry the loader registry
* @param store optional MetaDataStore used to resolve resources reference to by their symbolic name
*/
@Constructor
public IncludeLoader(@Reference LoaderRegistry registry, @Reference(required = false) MetaDataStore store) {
super(registry);
this.store = store;
addAttributes("name", "scdlResource", "requires");
}
public QName getXMLType() {
return INCLUDE;
}
public Include load(XMLStreamReader reader, IntrospectionContext context) throws XMLStreamException {
Location startLocation = reader.getLocation();
String nameAttr = reader.getAttributeValue(null, "name");
if (nameAttr == null || nameAttr.length() == 0) {
MissingAttribute failure = new MissingAttribute("Missing name attribute", startLocation);
context.addError(failure);
return null;
}
QName name = LoaderUtil.getQName(nameAttr, context.getTargetNamespace(), reader.getNamespaceContext());
String scdlResource = reader.getAttributeValue(null, "scdlResource");
Include include = new Include();
validateAttributes(reader, context, include);
LoaderUtil.skipToEndElement(reader);
ClassLoader cl = context.getClassLoader();
URI contributionUri = context.getContributionUri();
URL url;
if (scdlResource != null) {
url = cl.getResource(scdlResource);
if (url == null) {
include.setName(name);
MissingComposite failure = new MissingComposite("Composite file not found: " + scdlResource, startLocation, include);
context.addError(failure);
return include;
}
loadFromSideFile(include, name, cl, contributionUri, url, reader, context);
return include;
} else {
if (store == null) {
// throw error as this is invalid in a bootstrap environment
throw new UnsupportedOperationException("scdlLocation or scdlResource must be supplied as no MetaDataStore is available");
}
try {
QNameSymbol symbol = new QNameSymbol(name);
include.setName(name);
ResourceElement element = store.resolve(contributionUri, Composite.class, symbol, context);
if (element == null) {
String id = name.toString();
MissingComposite failure = new MissingComposite("Composite not found: " + id, startLocation, include);
context.addError(failure);
// add pointer
URI uri = context.getContributionUri();
Composite pointer = new Composite(name, true, uri);
include.setIncluded(pointer);
return include;
}
Composite composite = element.getValue();
include.setIncluded(composite);
return include;
} catch (StoreException e) {
ElementLoadFailure failure = new ElementLoadFailure("Error loading element", e, startLocation);
context.addError(failure);
return include;
}
}
}
private void loadFromSideFile(Include include,
QName name,
ClassLoader cl,
URI contributionUri,
URL url,
XMLStreamReader reader,
IntrospectionContext context) {
IntrospectionContext childContext = new DefaultIntrospectionContext(contributionUri, cl, url);
Location startLocation = reader.getLocation();
Composite composite;
try {
Source source = new UrlSource(url);
composite = registry.load(source, Composite.class, childContext);
} catch (LoaderException e) {
InvalidInclude failure = new InvalidInclude("Error loading include: " + name, e, startLocation, include);
context.addError(failure);
return;
}
if (childContext.hasErrors()) {
context.addErrors(childContext.getErrors());
}
if (childContext.hasWarnings()) {
context.addWarnings(childContext.getWarnings());
}
include.setName(name);
include.setScdlLocation(url);
include.setIncluded(composite);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy