Java tutorial
/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you 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.apache.felix.bundleplugin; import java.io.File; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.util.Collection; import java.util.Iterator; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; import java.util.Properties; import java.util.jar.Manifest; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; import org.apache.maven.project.MavenProject; import aQute.lib.osgi.Analyzer; import aQute.lib.osgi.Builder; import aQute.lib.osgi.Jar; /** * Generate an OSGi manifest for this project * * @goal manifest * @phase process-classes * @requiresDependencyResolution test */ public class ManifestPlugin extends BundlePlugin { protected void execute(MavenProject project, Map instructions, Properties properties, Jar[] classpath) throws MojoExecutionException { Manifest manifest; try { if ("bundle".equals(project.getPackaging())) { Builder builder = buildOSGiBundle(project, instructions, properties, classpath); manifest = builder.getJar().getManifest(); builder.close(); } else { manifest = getManifest(project, instructions, properties, classpath); } } catch (FileNotFoundException e) { throw new MojoExecutionException( "Cannot find " + e.getMessage() + " (manifest goal must be run after compile phase)", e); } catch (IOException e) { throw new MojoExecutionException("Error trying to generate Manifest", e); } catch (MojoFailureException e) { getLog().error(e.getLocalizedMessage()); throw new MojoExecutionException("Error(s) found in manifest configuration", e); } catch (Exception e) { getLog().error("An internal error occurred", e); throw new MojoExecutionException("Internal error in maven-bundle-plugin", e); } File outputFile = new File(manifestLocation, "MANIFEST.MF"); try { writeManifest(manifest, outputFile); } catch (IOException e) { throw new MojoExecutionException("Error trying to write Manifest to file " + outputFile, e); } } public Manifest getManifest(MavenProject project, Jar[] classpath) throws IOException, MojoFailureException, MojoExecutionException { return getManifest(project, new Properties(), new Properties(), classpath); } public Manifest getManifest(MavenProject project, Map instructions, Properties properties, Jar[] classpath) throws IOException, MojoFailureException, MojoExecutionException { Analyzer analyzer = getAnalyzer(project, instructions, properties, classpath); List errors = analyzer.getErrors(); List warnings = analyzer.getWarnings(); for (Iterator w = warnings.iterator(); w.hasNext();) { String msg = (String) w.next(); getLog().warn("Warning in manifest for " + project.getArtifact() + " : " + msg); } for (Iterator e = errors.iterator(); e.hasNext();) { String msg = (String) e.next(); getLog().error("Error in manifest for " + project.getArtifact() + " : " + msg); } if (errors.size() > 0) { String failok = analyzer.getProperty("-failok"); if (null == failok || "false".equalsIgnoreCase(failok)) { throw new MojoFailureException("Error(s) found in manifest configuration"); } } Manifest manifest = analyzer.getJar().getManifest(); // cleanup... analyzer.close(); return manifest; } protected Analyzer getAnalyzer(MavenProject project, Jar[] classpath) throws IOException, MojoExecutionException { return getAnalyzer(project, new LinkedHashMap(), new Properties(), classpath); } protected Analyzer getAnalyzer(MavenProject project, Map instructions, Properties properties, Jar[] classpath) throws IOException, MojoExecutionException { File file = project.getArtifact().getFile(); if (file == null) { file = getOutputDirectory(); } if (!file.exists()) { throw new FileNotFoundException(file.getPath()); } properties.putAll(getDefaultProperties(project)); properties.putAll(transformDirectives(instructions)); PackageVersionAnalyzer analyzer = new PackageVersionAnalyzer(); if (project.getBasedir() != null) analyzer.setBase(project.getBasedir()); analyzer.setProperties(properties); if (classpath != null) analyzer.setClasspath(classpath); analyzer.setJar(file); if (analyzer.getProperty(Analyzer.EXPORT_PACKAGE) == null && analyzer.getProperty(Analyzer.EXPORT_CONTENTS) == null && analyzer.getProperty(Analyzer.PRIVATE_PACKAGE) == null) { String export = analyzer.calculateExportsFromContents(analyzer.getJar()); analyzer.setProperty(Analyzer.EXPORT_PACKAGE, export); } // Apply Embed-Dependency headers, even though the contents won't be changed Collection embeddableArtifacts = getEmbeddableArtifacts(project, analyzer); new DependencyEmbedder(getLog(), embeddableArtifacts).processHeaders(analyzer); dumpInstructions("BND Instructions:", analyzer.getProperties(), getLog()); dumpClasspath("BND Classpath:", analyzer.getClasspath(), getLog()); analyzer.mergeManifest(analyzer.getJar().getManifest()); analyzer.calcManifest(); dumpManifest("BND Manifest:", analyzer.getJar().getManifest(), getLog()); return analyzer; } public static void writeManifest(Manifest manifest, File outputFile) throws IOException { outputFile.getParentFile().mkdirs(); FileOutputStream os; os = new FileOutputStream(outputFile); try { manifest.write(os); } finally { try { os.close(); } catch (IOException e) { // nothing we can do here } } } }