Unable to create a karaf-assembly using karaf-maven-plugin when feature requires wrap protocol

[rougeSE]

I have a project that is generating karaf features, some of the dependencies that we use have their own dependencies that are not compatible with OSGI, so the generated feature file utilizes the wrap protocol to expose those dependencies within OSGI.

When trying to generate the karaf assemble with karaf-maven-plugin, there are errors with regards to missing requirements that I have found no way around.

[ERROR] Failed to execute goal org.apache.karaf.tooling:karaf-maven-plugin:4.4.5:assembly (default-assembly) on project test-karaf-assembly: Unable to build assembly: Unable to resolve root: missing requirement [root] osgi.identity; osgi.identity=wrap; type=karaf.feature; version=0; filter:="(&(osgi.identity=wrap)(type=karaf.feature)(version>=0.0.0))" -> [Help 1]

The feature being generated is using CXF as an example with a pom as follows

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.example</groupId>
	<artifactId>test-karaf-feature</artifactId>
	<version>1.0.0</version>
	<packaging>feature</packaging>
	<properties>
		<karaf.version>4.4.5</karaf.version>
	</properties>

	<dependencies>
		<!-- Example dependencies to be converted to bundles -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxws</artifactId>
			<version>3.3.9</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.karaf.tooling</groupId>
				<artifactId>karaf-maven-plugin</artifactId>
				<version>${karaf.version}</version>
				<extensions>true</extensions>					
			</plugin>
			<plugin>
				<!-- Version 3.X of the install plugin doesn't seem compatible with the feature packaging of the karaf-maven-plugin resulting in error unless we specify the allowIncompleteProjects=true-->
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-install-plugin</artifactId>
				<configuration>
					<allowIncompleteProjects>true</allowIncompleteProjects>
				</configuration>
			</plugin>
			<plugin>
				<!-- Version 3.X of the deploy plugin doesn't seem compatible with the feature packaging of the karaf-maven-plugin resulting in error unless we specify the allowIncompleteProjects=true-->
				<artifactId>maven-deploy-plugin</artifactId>
				<configuration>
					<allowIncompleteProjects>true</allowIncompleteProjects>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

The assembly is being generated with the following pom

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>com.raytheon.eclipse.portal</groupId>
		<artifactId>portal-parent</artifactId>
		<version>${revision}${changelist}</version>
	</parent>
	<artifactId>test-karaf-assembly</artifactId>
	<packaging>karaf-assembly</packaging>
	<properties>
		<karaf.version>4.4.5</karaf.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.apache.karaf.features</groupId>
			<artifactId>framework</artifactId>
			<version>${karaf.version}</version>
			<type>kar</type>
		</dependency>
		<dependency>
			<groupId>org.apache.karaf.features</groupId>
			<artifactId>standard</artifactId>
			<version>${karaf.version}</version>
			<classifier>features</classifier>
			<type>xml</type>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>com.example</groupId>
			<artifactId>test-karaf-feature</artifactId>
			<version>1.0.0</version>
			<classifier>features</classifier>
			<type>xml</type>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.karaf.tooling</groupId>
				<artifactId>karaf-maven-plugin</artifactId>
				<version>${karaf.version}</version>
				<extensions>true</extensions>
				<configuration>
					<finalName>${project.artifactId}</finalName>
					<installedBundles>
						<installedBundle>${additional.bundle}</installedBundle>
					</installedBundles>
					<bootFeatures>
						<feature>bundle</feature>
						<feature>config</feature>
						<feature>diagnostic</feature>
						<feature>feature</feature>
						<feature>jaas</feature>
						<feature>shell</feature>
						<feature>log</feature>
						<feature>management</feature>
						<feature>package</feature>
						<feature>shell-compat</feature>
						<feature>ssh</feature>
						<feature>system</feature>
						<feature>wrap</feature>
					</bootFeatures>
					<archiveZip>false</archiveZip>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

Workaround Attempts

Tried to resolve by creating a /src/main/feature/feature.xml template that included the karaf feature repository and enabling the enableGeneration option.

src/main/feature/feature.xml

<features name="${project.artificatId}" xmlns="http://karaf.apache.org/xmlns/features/v1.6.0">
    <repository>mvn:org.apache.karaf.features/standard/${karaf.version}/xml/features</repository>
    <feature name="${project.artifactId}" version="${project.version}">
        <feature>wrap</feature>
        <!-- plugin will add bundles here -->
    </feature>
</features>

Which resulted in this error during the assembly
[ERROR] Failed to execute goal [32morg.apache.karaf.tooling:karaf-maven-plugin:4.4.5:assembly (default-assembly) on project test-karaf-assembly Unable to build assembly: Unable to resolve root: missing requirement [root] osgi.identity; osgi.identity=wrap; type=karaf.feature; version=0; filter:="(&(osgi.identity=wrap)(type=karaf.feature)(version>=0.0.0))" [caused by: Unable to resolve wrap/2.6.14: missing requirement [wrap/2.6.14] osgi.identity; osgi.identity=pax-url-wrap; type=karaf.feature; version="[2.6.14,2.6.14]" [caused by: Unable to resolve pax-url-wrap/2.6.14: missing requirement [pax-url-wrap/2.6.14] osgi.identity; osgi.identity=org.ops4j.pax.url.wrap; type=osgi.bundle; version="[2.6.14,2.6.14]"; resolution:=mandatory [caused by: Unable to resolve org.ops4j.pax.url.wrap/2.6.14: missing requirement [org.ops4j.pax.url.wrap/2.6.14] osgi.wiring.package; filter:="(&(osgi.wiring.package=org.osgi.service.log)(version>=1.3.0)(!(version>=2.0.0)))"]]] -> [Help 1]

I suppose this might have worked if the wrap feature had declared the pax-logging-api bundle but it did not.

[jbonofre]

Using wrap in features repository requires to have <feature prerequisite="true">pax-url-wrap</feature>.

You can take example on the karaf-integration features repository and distribution:

• https://github.com/apache/karaf/blob/main/assemblies/features/integration/
• https://github.com/apache/karaf/tree/main/assemblies/apache-karaf-integration

If you want, I can fix your project. Do you mind to share your code ? Else I can create a simple sample for you.

[rougeSE]

JB, thank your for responding so quickly,

Unfortunately, I am unable to provide much more than I have already. If it is possible to show me what needs to be modified in my examples above, that would very helpful.

From what I understand the "wrap" and "pax-url-wrap" are equivalents to each other, the "wrap" feature seems to just call the "pack-url-wrap" but looks like "pax-url-wrap" is probably the preferred feature name to use.

With the use of the /src/manin/feature.xml template above and switching from "wrap" to "pax-url-wrap", I get a generated feature.xml file that looks like this, which I think meets all the prerequisites.

Generated Feature file

<features xmlns="http://karaf.apache.org/xmlns/features/v1.6.0" name="${project.artificatId}">
    <repository>mvn:org.apache.karaf.features/standard/4.4.5/xml/features</repository>
    <feature name="test-karaf-feature" description="test-karaf-feature" version="1.0.0">
        <feature prerequisite="true">pax-url-wrap</feature>
        <feature prerequisite="true" dependency="false">wrap</feature>
        <bundle>mvn:org.apache.cxf/cxf-rt-frontend-jaxws/3.3.9</bundle>
        <bundle>wrap:mvn:xml-resolver/xml-resolver/1.2</bundle>
        <bundle>mvn:org.ow2.asm/asm/9.0</bundle>
        <bundle>mvn:org.apache.cxf/cxf-core/3.3.9</bundle>
        <bundle>wrap:mvn:org.glassfish.jaxb/jaxb-runtime/2.3.2</bundle>
        <bundle>wrap:mvn:org.glassfish.jaxb/txw2/2.3.2</bundle>
        <bundle>mvn:com.sun.istack/istack-commons-runtime/3.0.8</bundle>
        <bundle>mvn:com.sun.xml.fastinfoset/FastInfoset/1.2.16</bundle>
        <bundle>mvn:jakarta.activation/jakarta.activation-api/1.2.1</bundle>
        <bundle>mvn:com.fasterxml.woodstox/woodstox-core/5.0.3</bundle>
        <bundle>mvn:org.codehaus.woodstox/stax2-api/3.1.4</bundle>
        <bundle>mvn:org.apache.ws.xmlschema/xmlschema-core/2.2.5</bundle>
        <bundle>mvn:jakarta.xml.bind/jakarta.xml.bind-api/2.3.2</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-bindings-soap/3.3.9</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-wsdl/3.3.9</bundle>
        <bundle>wrap:mvn:wsdl4j/wsdl4j/1.6.3</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-databinding-jaxb/3.3.9</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-bindings-xml/3.3.9</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-frontend-simple/3.3.9</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-ws-addr/3.3.9</bundle>
        <bundle>mvn:org.apache.cxf/cxf-rt-ws-policy/3.3.9</bundle>
        <bundle>mvn:org.apache.neethi/neethi/3.1.1</bundle>
        <bundle>mvn:javax.annotation/javax.annotation-api/1.3.2</bundle>
        <bundle>mvn:javax.xml.ws/jaxws-api/2.3.1</bundle>
        <bundle>mvn:javax.xml.soap/javax.xml.soap-api/1.4.0</bundle>
        <bundle>mvn:com.sun.activation/javax.activation/1.2.0</bundle>
        <bundle>mvn:org.apache.geronimo.specs/geronimo-ws-metadata_2.0_spec/1.1.3</bundle>
        <bundle>wrap:mvn:com.sun.xml.messaging.saaj/saaj-impl/1.4.0-b03</bundle>
        <bundle>mvn:org.jvnet.mimepull/mimepull/1.9.7</bundle>
        <bundle>mvn:org.jvnet.staxex/stax-ex/1.7.8</bundle>
        <bundle>wrap:mvn:javax.activation/activation/1.1</bundle>
        <bundle>wrap:mvn:org.jacorb/jacorb-omgapi/3.9</bundle>
        <bundle>mvn:org.apache.geronimo.specs/geronimo-jta_1.1_spec/1.1.1</bundle>
        <bundle>wrap:mvn:org.jboss.spec.javax.rmi/jboss-rmi-api_1.0_spec/1.0.6.Final</bundle>
    </feature>
</features>

But when I try and build my karaf-assembly referencing this feature I still get the error complaining about the missing requirement of org.osgi.service.log. It seems I am so close but can't figure out how to satisfy the feature requirement when building the assembly.