org.fusesource.fabric.agent.ObrResolver Maven / Gradle / Ivy
/**
* Copyright (C) FuseSource, Inc.
* http://fusesource.com
*
* 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 org.fusesource.fabric.agent;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import org.apache.felix.bundlerepository.Property;
import org.apache.felix.bundlerepository.Reason;
import org.apache.felix.bundlerepository.Repository;
import org.apache.felix.bundlerepository.RepositoryAdmin;
import org.apache.felix.bundlerepository.Requirement;
import org.apache.felix.bundlerepository.Resource;
import org.apache.felix.bundlerepository.impl.ResourceImpl;
import org.apache.karaf.features.BundleInfo;
import org.apache.karaf.features.Feature;
import org.fusesource.fabric.fab.DependencyTree;
import org.fusesource.fabric.fab.osgi.FabBundleInfo;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.Version;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ObrResolver {
private static final Logger LOGGER = LoggerFactory.getLogger(ObrResolver.class);
private RepositoryAdmin repositoryAdmin;
private boolean resolveOptionalImports;
public ObrResolver() {
}
public ObrResolver(RepositoryAdmin repositoryAdmin) {
this.repositoryAdmin = repositoryAdmin;
}
public RepositoryAdmin getRepositoryAdmin() {
return repositoryAdmin;
}
public void setRepositoryAdmin(RepositoryAdmin repositoryAdmin) {
this.repositoryAdmin = repositoryAdmin;
}
public boolean isResolveOptionalImports() {
return resolveOptionalImports;
}
/**
* When set to true, the OBR resolver will try to resolve optional imports as well.
* Defaults to false
*
* @param resolveOptionalImports
*/
public void setResolveOptionalImports(boolean resolveOptionalImports) {
this.resolveOptionalImports = resolveOptionalImports;
}
public List resolve(Set features,
Set bundles,
Map fabs,
Set overrides,
Map downloads) throws Exception {
List reqs = new ArrayList();
List ress = new ArrayList();
List deploy = new ArrayList();
Map infos = new HashMap();
for (Feature feature : features) {
for (BundleInfo bundleInfo : feature.getBundles()) {
try {
//We ignore Fabs completely as the are already been added to fabs set.
if (!bundleInfo.getLocation().startsWith(DeploymentAgent.FAB_PROTOCOL)) {
Resource res = createResource(bundleInfo.getLocation(), downloads, fabs);
if (res == null) {
throw new IllegalArgumentException("Unable to build OBR representation for bundle " + bundleInfo.getLocation());
}
ress.add(res);
infos.put(res, bundleInfo);
}
} catch (MalformedURLException e) {
//try wait a bit for the url handler service available
Thread.sleep(15000);
try {
if (!bundleInfo.getLocation().startsWith(DeploymentAgent.FAB_PROTOCOL)) {
Resource res = createResource(bundleInfo.getLocation(), downloads, fabs);
if (res == null) {
throw new IllegalArgumentException("Unable to build OBR representation for bundle " + bundleInfo.getLocation());
}
ress.add(res);
infos.put(res, bundleInfo);
}
}catch (MalformedURLException ex) {
LOGGER.error("MalformedURLException {}", e.getMessage());
Requirement req = parseRequirement(bundleInfo.getLocation());
reqs.add(req);
infos.put(req, bundleInfo);
}
}
}
}
for (String bundle : bundles) {
Resource res = createResource(bundle, downloads, fabs);
if (res == null) {
throw new IllegalArgumentException("Unable to build OBR representation for bundle " + bundle);
}
ress.add(res);
infos.put(res, new SimpleBundleInfo(bundle, false));
}
for (FabBundleInfo fab : fabs.values()) {
Resource res = repositoryAdmin.getHelper().createResource(fab.getManifest());
if (res == null) {
throw new IllegalArgumentException("Unable to build OBR representation for fab " + fab.getUrl());
}
((ResourceImpl) res).put(Resource.URI, DeploymentAgent.FAB_PROTOCOL + fab.getUrl(), Property.URI);
ress.add(res);
infos.put(res, new SimpleBundleInfo(fab.getUrl(), false));
for (DependencyTree dep : fab.getBundles()) {
if (dep.isBundle()) {
URL url = new URL(dep.getUrl());
Resource resDep = createResource(dep.getUrl(), downloads, fabs);
if (resDep == null) {
throw new IllegalArgumentException("Unable to build OBR representation for fab dependency " + url);
}
ress.add(resDep);
infos.put(resDep, new SimpleBundleInfo(dep.getUrl(), true));
}
}
}
for (String override : overrides) {
Resource over = null;
try {
over = createResource(override, downloads, fabs);
} catch (Exception e) {
if (LOGGER.isDebugEnabled()) {
LOGGER.info("Ignoring patched resource: {}: {}", new Object[] { override, e.getMessage() }, e);
} else {
LOGGER.info("Ignoring patched resource: {}: {}", override, e.getMessage());
}
}
if (over == null) {
// Artifacts may not be valid bundles, so just ignore those artifacts
continue;
}
boolean add = false;
boolean dependency = true;
for (Resource res : new ArrayList(ress)) {
if (res.getSymbolicName().equals(over.getSymbolicName())) {
Version v1 = res.getVersion();
Version v2 = new Version(v1.getMajor(), v1.getMinor() + 1, 0);
if (compareFuseVersions(v1, over.getVersion()) < 0 && compareFuseVersions(over.getVersion(), v2) < 0) {
ress.remove(res);
add = true;
// if the BundleInfo object has not been previously removed from the map, do that now
BundleInfo removed = infos.remove(res);
if (removed != null) {
dependency &= removed.isDependency();
}
}
}
}
if (add) {
ress.add(over);
infos.put(over, new SimpleBundleInfo(override, dependency));
}
}
Repository repository = repositoryAdmin.getHelper().repository(ress.toArray(new Resource[ress.size()]));
List repos = new ArrayList();
repos.add(repositoryAdmin.getSystemRepository());
repos.add(repository);
repos.addAll(Arrays.asList(repositoryAdmin.listRepositories()));
org.apache.felix.bundlerepository.Resolver resolver = repositoryAdmin.resolver(repos.toArray(new Repository[repos.size()]));
for (Resource res : ress) {
if (!infos.get(res).isDependency()) {
resolver.add(res);
}
}
for (Requirement req : reqs) {
resolver.add(req);
}
if (!doResolve(resolver)) {
StringWriter w = new StringWriter();
PrintWriter out = new PrintWriter(w);
Reason[] failedReqs = resolver.getUnsatisfiedRequirements();
if ((failedReqs != null) && (failedReqs.length > 0)) {
out.println("Unsatisfied requirement(s):");
printUnderline(out, 27);
for (Reason r : failedReqs) {
out.println(" " + r.getRequirement().getName() + ":" + r.getRequirement().getFilter());
out.println(" " + r.getResource().getPresentationName());
}
} else {
out.println("Could not resolve targets.");
}
out.flush();
throw new Exception("Can not resolve feature:\n" + w.toString());
}
Collections.addAll(deploy, resolver.getAddedResources());
Collections.addAll(deploy, resolver.getRequiredResources());
if (resolveOptionalImports) {
Collections.addAll(deploy, resolver.getOptionalResources());
}
return deploy;
}
private boolean doResolve(org.apache.felix.bundlerepository.Resolver resolver) {
if (resolveOptionalImports) {
return resolver.resolve();
} else {
return resolver.resolve(org.apache.felix.bundlerepository.Resolver.NO_OPTIONAL_RESOURCES);
}
}
private int compareFuseVersions(org.osgi.framework.Version v1, org.osgi.framework.Version v2) {
int c = v1.getMajor() - v2.getMajor();
if (c != 0) {
return c;
}
c = v1.getMinor() - v2.getMinor();
if (c != 0) {
return c;
}
c = v1.getMicro() - v2.getMicro();
if (c != 0) {
return c;
}
String q1 = v1.getQualifier();
String q2 = v2.getQualifier();
if (q1.startsWith("fuse-") && q2.startsWith("fuse-")) {
q1 = cleanQualifierForComparison(q1);
q2 = cleanQualifierForComparison(q2);
}
return q1.compareTo(q2);
}
private String cleanQualifierForComparison(String q) {
return q.replace("-alpha-", "-").replace("-beta-", "-")
.replace("-7-0-", "-70-")
.replace("-7-", "-70-");
}
protected Resource createResource(String uri, Map urls, Map infos) throws Exception {
URL url = new URL(uri);
Attributes attributes = getAttributes(uri, urls, infos);
ResourceImpl resource = (ResourceImpl) repositoryAdmin.getHelper().createResource(attributes);
if (resource != null) {
if ("file".equals(url.getProtocol()))
{
try {
File f = new File(url.toURI());
resource.put(Resource.SIZE, Long.toString(f.length()), null);
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
}
resource.put(Resource.URI, url.toExternalForm(), null);
}
return resource;
}
protected Attributes getAttributes(String uri, Map urls, Map infos) throws Exception {
InputStream is = DeploymentAgent.getBundleInputStream(uri, urls, infos);
byte[] man = loadEntry(is, JarFile.MANIFEST_NAME);
if (man == null)
{
throw new IllegalArgumentException("The specified url is not a valid jar (can't read manifest): " + uri);
}
Manifest manifest = new Manifest(new ByteArrayInputStream(man));
return manifest.getMainAttributes();
}
private byte[] loadEntry(InputStream is, String name) throws IOException
{
try
{
ZipInputStream jis = new ZipInputStream(is);
for (ZipEntry e = jis.getNextEntry(); e != null; e = jis.getNextEntry())
{
if (name.equalsIgnoreCase(e.getName()))
{
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buf = new byte[1024];
int n;
while ((n = jis.read(buf, 0, buf.length)) > 0)
{
baos.write(buf, 0, n);
}
return baos.toByteArray();
}
}
}
finally
{
is.close();
}
return null;
}
protected void printUnderline(PrintWriter out, int length) {
for (int i = 0; i < length; i++) {
out.print('-');
}
out.println("");
}
protected Requirement parseRequirement(String req) throws InvalidSyntaxException {
int p = req.indexOf(':');
String name;
String filter;
if (p > 0) {
name = req.substring(0, p);
filter = req.substring(p + 1);
} else {
if (req.contains("package")) {
name = "package";
} else if (req.contains("service")) {
name = "service";
} else {
name = "bundle";
}
filter = req;
}
if (!filter.startsWith("(")) {
filter = "(" + filter + ")";
}
return repositoryAdmin.getHelper().requirement(name, filter);
}
private static class SimpleBundleInfo implements BundleInfo {
private final String bundle;
private final boolean dependency;
public SimpleBundleInfo(String bundle, boolean dependency) {
this.bundle = bundle;
this.dependency = dependency;
}
@Override
public String getLocation() {
return bundle;
}
@Override
public int getStartLevel() {
return 0;
}
@Override
public boolean isStart() {
return true;
}
@Override
public boolean isDependency() {
return dependency;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy