org.apache.karaf.tooling

Class AssemblyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.karaf.tooling.utils.MojoSupport

org.apache.karaf.tooling.AssemblyMojo

All Implemented Interfaces:

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

@Mojo(name="assembly",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class AssemblyMojo
extends MojoSupport

Creates a customized Karaf distribution by installing features and setting up configuration files. The plugin gets features from feature.xml files and KAR archives declared as dependencies or as files configured with the featureRespositories parameter. It picks up other files, such as config files, from ${project.build.directory}/classes. Thus, a file in src/main/resources/etc will be copied by the resource plugin to ${project.build.directory}/classes/etc, and then added to the assembly by this goal.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	config
protected int	defaultStartLevel default start level for bundles in features that don't specify it.
protected List<String>	featureRepositories Additional feature repositories
protected File	featuresCfgFile Features configuration file (etc/org.apache.karaf.features.cfg).
protected String	framework Specify which framework to use (one of framework, framework-logback, static-framework, static-framework-logback).
protected boolean	ignoreDependencyFlag Ignore the dependency attribute (dependency="[true|false]") on bundle
protected boolean	includeBuildOutputDirectory Include project build output directory in the assembly
protected boolean	installAllFeaturesByDefault
protected String	javase Specify the version of Java SE to be assumed for osgi.ee.
protected org.apache.karaf.profile.assembly.Builder.KarafVersion	karafVersion
protected List<String>	libraries
protected List<String>	pidsToExtract Glob specifying which configuration pids in the selected boot features should be extracted to the etc directory.
protected String	propertyFileEdits Specify an XML file that instructs this goal to apply edits to one or more standard Karaf property files.
protected File	sourceDirectory Base directory used to overwrite resources in generated assembly after the build (resource directory).
protected File	startupPropertiesFile startup.properties file.
protected Map<String,String>	system
protected File	systemDirectory Directory used during build to construction the Karaf system repository.
protected Map<String,String>	translatedUrls Specify a set of translated urls to use instead of downloading the artifacts from their original locations.
protected boolean	useReferenceUrls Use reference: style urls in startup.properties
protected File	workDirectory Base directory used to copy the resources during the build (working directory).

Fields inherited from class org.apache.karaf.tooling.utils.MojoSupport

artifactMetadataSource, artifactResolver, container, factory, localRepo, mavenSession, project, projectBuilder, projectHelper, remoteRepos

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AssemblyMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doExecute()
void	execute()

Methods inherited from class org.apache.karaf.tooling.utils.MojoSupport

copy, createManagedVersionMap, getLocalRepoUrl, getProject, getProjectHelper, getWorkDirectory, resourceToArtifact, setMavenSession, translateFromMaven

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceDirectory

@Parameter(defaultValue="${project.basedir}/src/main/resources/assembly")
protected File sourceDirectory

Base directory used to overwrite resources in generated assembly after the build (resource directory).

workDirectory

@Parameter(defaultValue="${project.build.directory}/assembly")
protected File workDirectory

Base directory used to copy the resources during the build (working directory).

featuresCfgFile

@Parameter(defaultValue="${project.build.directory}/assembly/etc/org.apache.karaf.features.cfg")
protected File featuresCfgFile

Features configuration file (etc/org.apache.karaf.features.cfg).

startupPropertiesFile

@Parameter(defaultValue="${project.build.directory}/assembly/etc/startup.properties")
protected File startupPropertiesFile

startup.properties file.

systemDirectory

@Parameter(defaultValue="${project.build.directory}/assembly/system")
protected File systemDirectory

Directory used during build to construction the Karaf system repository.

defaultStartLevel

@Parameter
protected int defaultStartLevel

default start level for bundles in features that don't specify it.

ignoreDependencyFlag

@Parameter(defaultValue="false")
protected boolean ignoreDependencyFlag

Ignore the dependency attribute (dependency="[true|false]") on bundle

featureRepositories

@Parameter
protected List<String> featureRepositories

Additional feature repositories

libraries

@Parameter
protected List<String> libraries

useReferenceUrls

@Parameter(defaultValue="false")
protected boolean useReferenceUrls

Use reference: style urls in startup.properties

includeBuildOutputDirectory

@Parameter(defaultValue="true")
protected boolean includeBuildOutputDirectory

Include project build output directory in the assembly

installAllFeaturesByDefault

@Parameter
protected boolean installAllFeaturesByDefault

karafVersion

@Parameter
protected org.apache.karaf.profile.assembly.Builder.KarafVersion karafVersion

javase

@Parameter(defaultValue="1.8")
protected String javase

Specify the version of Java SE to be assumed for osgi.ee.

framework

@Parameter
protected String framework

Specify which framework to use (one of framework, framework-logback, static-framework, static-framework-logback).

propertyFileEdits

@Parameter(defaultValue="${project.basedir}/src/main/karaf/assembly-property-edits.xml")
protected String propertyFileEdits

Specify an XML file that instructs this goal to apply edits to one or more standard Karaf property files. The contents of this file are documented in detail on this page. This allows you to customize these files without making copies in your resources directories. Here's a simple example:

 
      <property-edits xmlns="http://karaf.apache.org/tools/property-edits/1.0.0">
         <edits>
          <edit>
            <file>config.properties</file>
            <operation>put</operation>
            <key>karaf.framework</key>
            <value>equinox</value>
          </edit>
          <edit>
            <file>config.properties</file>
            <operation>extend</operation>
            <key>org.osgi.framework.system.capabilities</key>
            <value>my-magic-capability</value>
          </edit>
          <edit>
            <file>config.properties</file>
            <operation prepend='true'>extend</operation>
            <key>some-other-list</key>
            <value>my-value-goes-first</value>
            </edit>
         </edits>
      </property-edits>
    
     

pidsToExtract

@Parameter
protected List<String> pidsToExtract

Glob specifying which configuration pids in the selected boot features should be extracted to the etc directory.

translatedUrls

@Parameter
protected Map<String,String> translatedUrls

Specify a set of translated urls to use instead of downloading the artifacts from their original locations. The given set will be extended with already built artifacts from the maven project.

config

@Parameter
protected Map<String,String> config

system

@Parameter
protected Map<String,String> system

Constructor Detail

AssemblyMojo

public AssemblyMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doExecute

protected void doExecute()
                  throws Exception

Throws:

Exception