Package org.apache.felix.bundleplugin

Class BundlePlugin

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.felix.bundleplugin.BundlePlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AntPlugin, InstructionsPlugin, ManifestPlugin

@Mojo(name="bundle",
      requiresDependencyResolution=TEST,
      threadSafe=true,
      defaultPhase=PACKAGE)
public class BundlePlugin
extends org.apache.maven.plugin.AbstractMojo

Create an OSGi bundle from Maven project

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BundlePlugin.ClassPathItem

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.maven.archiver.MavenArchiveConfiguration	archive	The archive configuration to use.
private org.apache.maven.artifact.resolver.ArtifactCollector	artifactCollector
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
private org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver	Artifact resolver, needed to download source jars for inclusion in classpath.
protected org.sonatype.plexus.build.incremental.BuildContext	buildContext
private String	buildDirectory	The directory for the generated JAR.
private static final String	BUNDLE_PLUGIN_EXTENSION
private static final String	BUNDLE_PLUGIN_PREPEND_EXTENSION
protected String	classifier	Classifier type of the bundle to be installed.
protected boolean	createDependencyReducedPom	If true, remove any inlined or embedded dependencies from the resulting pom.
private static final String[]	DEFAULT_INCLUDES
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder	dependencyGraphBuilder
protected File	dependencyReducedPomLocation	Where to put the dependency reduced pom.
protected File	dumpClasspath	File where the BND class-path will be dumped
protected File	dumpInstructions	File where the BND instructions will be dumped
private static final String[]	EMPTY_STRING_ARRAY
protected String	excludeDependencies	Comma separated list of artifactIds to exclude from the dependency classpath passed to BND (use "true" to exclude everything)
protected boolean	exportScr	When true, dump the generated SCR files
private String	finalName	Final name of the bundle (without classifier or extension)
private Map<String,String>	instructions	The BND instructions for the bundle.
private static final String	LOCAL_PACKAGES
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository	Local maven repository.
private org.codehaus.plexus.archiver.manager.ArchiverManager	m_archiverManager
private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager	m_artifactHandlerManager
private final Maven2OsgiConverter	m_maven2OsgiConverter	Use locally patched version for now.
private org.apache.maven.execution.MavenSession	m_mavenSession
private org.apache.maven.project.MavenProjectHelper	m_projectHelper
protected File	manifestLocation	Directory where the manifest will be written
private static final String	MAVEN_RESOURCES
private static final String	MAVEN_SOURCES
private static final String	MAVEN_SYMBOLICNAME
private static final String	MAVEN_TEST_RESOURCES
private static final String	MAVEN_TEST_SOURCES
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder	ProjectBuilder, needed to create projects from the artifacts.
protected boolean	niceManifest	Output a nicely formatted manifest that still respects the 72 character line limit.
private static final String	NL
protected List<String>	noWarningProjectTypes	Project types which are not supported, but silently ignored.
private File	outputDirectory	The directory for the generated bundles.
private String	outputTimestamp	Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
protected String	packaging	Packaging type of the bundle to be installed.
protected org.apache.maven.project.MavenProject	project	The Maven project.
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteArtifactRepositories	Remote repositories which will be searched for source attachments.
protected File	scrLocation	Directory where the SCR files will be written
protected org.apache.maven.execution.MavenSession	session
private boolean	skip
protected List<String>	supportedProjectTypes	Project types which this plugin supports.
protected boolean	unpackBundle	When true, unpack the bundle contents to the outputDirectory

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
BundlePlugin()

Method Summary

Modifier and Type

Method

Description

private static void

addLocalPackages(File outputDirectory, aQute.bnd.osgi.Analyzer analyzer)

protected void

addMavenInstructions(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Builder builder)

protected static void

addMavenSourcePath(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Analyzer analyzer, org.apache.maven.plugin.logging.Log log)

protected aQute.bnd.osgi.Builder

buildOSGiBundle(org.apache.maven.project.MavenProject currentProject, Map<String,String> originalInstructions, BundlePlugin.ClassPathItem[] classpath)

protected String

convertVersionToOsgi(String version)

Convert a Maven version into an OSGi compliant version

private String

createdBy(String description, String groupId, String artifactId)

private void

createDependencyReducedPom(Set<String> artifactsToRemove)

private void

doMavenMetadata(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Jar jar)

protected static StringBuilder

dumpClasspath(List<aQute.bnd.osgi.Jar> classpath, StringBuilder buf)

protected static StringBuilder

dumpInstructions(Properties properties, StringBuilder buf)

protected static StringBuilder

dumpManifest(Manifest manifest, StringBuilder buf)

void

execute()

protected void

execute(Map<String,String> originalInstructions, BundlePlugin.ClassPathItem[] classpath)

private static Attributes

filterAttributes(aQute.bnd.osgi.Instructions instructions, Attributes source, Set<aQute.bnd.osgi.Instruction> nomatch)

protected static File

getBase(org.apache.maven.project.MavenProject currentProject)

protected String

getBuildDirectory()

protected String

getBundleName(org.apache.maven.project.MavenProject currentProject)

TODO this should return getMaven2Osgi().getBundleFileName( project.getArtifact() )

protected BundlePlugin.ClassPathItem[]

getClasspath(org.apache.maven.project.MavenProject currentProject)

private static String

getCreatedByVersion(String groupId, String artifactId)

protected Properties

getDefaultProperties(org.apache.maven.project.MavenProject currentProject)

protected Collection<org.apache.maven.artifact.Artifact>

getEmbeddableArtifacts(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Analyzer analyzer)

protected File

getFile(org.apache.maven.artifact.Artifact artifact)

Get the file for an Artifact

private String

getId(String groupId, String artifactId, String type, String classifier)

private String

getId(org.apache.maven.artifact.Artifact artifact)

private String

getId(org.apache.maven.model.Dependency dependency)

protected Map<String,String>

getInstructions()

protected Maven2OsgiConverter

getMaven2OsgiConverter()

protected static String

getMavenResourcePaths(org.apache.maven.project.MavenProject currentProject, boolean test)

private static List<org.apache.maven.model.Resource>

getMavenResources(org.apache.maven.project.MavenProject currentProject, boolean test)

protected Set<String>

getOptionalPackages(org.apache.maven.project.MavenProject currentProject)

protected aQute.bnd.osgi.Builder

getOSGiBuilder(org.apache.maven.project.MavenProject currentProject, Map<String,String> originalInstructions, BundlePlugin.ClassPathItem[] classpath)

protected File

getOutputDirectory()

private static String

getPackageName(String filename)

protected org.apache.maven.project.MavenProject

getProject()

private static Map<String,String>

getProperties(org.apache.maven.model.Model projectModel, String prefix)

private Collection<org.apache.maven.artifact.Artifact>

getSelectedDependencies(Collection<org.apache.maven.artifact.Artifact> artifacts)

private static void

header(Properties properties, String key, Object value)

protected static void

includeJava9Fixups(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Analyzer analyzer)

Downgrade the message "Classes found in the wrong directory" to a warning.

protected static void

includeMavenResources(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Analyzer analyzer, org.apache.maven.plugin.logging.Log log)

protected boolean

isTransitivelyOptional(HashSet<String> optionalArtifactIds, org.apache.maven.artifact.Artifact artifact)

Check to see if any dependency along the dependency trail of the artifact is optional.

private static void

mergeAttributes(Attributes... attributesArray)

protected static void

mergeManifest(aQute.bnd.osgi.Instructions instructions, Manifest... manifests)

protected void

mergeMavenManifest(org.apache.maven.project.MavenProject currentProject, aQute.bnd.osgi.Builder builder)

private static StringBuffer

printLicenses(List<org.apache.maven.model.License> licenses)

protected static String

removeTagFromInstruction(String instruction, String tag)

protected boolean

reportErrors(String prefix, aQute.bnd.osgi.Analyzer analyzer)

protected static String