br.com.c8tech.tools.maven.plugin.osgi.container

Class MojoGenerateOsgiAssemblyArchive

java.lang.Object

org.apache.maven.plugin.AbstractMojo

br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

br.com.c8tech.tools.maven.plugin.osgi.container.MojoGenerateOsgiAssemblyArchive

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.plugins.assembly.AssemblerConfigurationSource

@Mojo(name="assembly",
      defaultPhase=PACKAGE,
      threadSafe=true,
      requiresProject=true,
      instantiationStrategy=PER_LOOKUP)
public class MojoGenerateOsgiAssemblyArchive
extends AbstractOsgiContainerPackMojo
implements org.apache.maven.plugins.assembly.AssemblerConfigurationSource

This mojo is aimed to build a distributable ZIP archive containing an OSGi container plus bundle dependencies and configuration files.

The developer must choose which OSGi framework to use in the configurations session.
All compile dependencies of the project will be added into the generated archive.

Author:

Cristiano Gavião

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	commandLinePropertiesInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	envInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	mainProjectInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	rootInterpolator

Fields inherited from class br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

DOWNLOAD_STATUS, EQUINOX_CONFIGURATION_NAME, EQUINOX_CONFIGURATION_PATH, FELIX_CONFIGURATION_NAME, FELIX_CONFIGURATION_PATH, PROPERTY_CACHE_DIR, PROPERTY_WORK_DIR

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

ROLE

Constructor Summary

Constructors

Constructor and Description
MojoGenerateOsgiAssemblyArchive(org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method and Description
protected boolean	doInitialValidation()
protected void	executeExtraInitializationSteps()
protected void	executeMojo()
File	getArchiveBaseDirectory()
String	getArchiverConfig()
org.apache.maven.plugins.assembly.archive.AssemblyArchiver	getAssemblyArchiver()
org.apache.maven.plugins.assembly.io.AssemblyReader	getAssemblyReader()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getCommandLinePropsInterpolator()
List<String>	getDelimiters()
String[]	getDescriptorReferences()
String[]	getDescriptors()
File	getDescriptorSourceDirectory()
String	getEncoding()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getEnvInterpolator()
String	getEscapeString()
List<String>	getFilters()
org.apache.maven.archiver.MavenArchiveConfiguration	getJarArchiveConfiguration()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getMainProjectInterpolator()
org.apache.maven.shared.filtering.MavenReaderFilter	getMavenReaderFilter()
String	getMergeManifestMode()
File	getOutputDirectory()
List<org.apache.maven.project.MavenProject>	getReactorProjects()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getRepositoryInterpolator()
File	getSiteDirectory()
String	getTarLongFileMode()
File	getTemporaryRootDirectory()
File	getWorkingDirectory()
boolean	isAssemblyIdAppended()
boolean	isDryRun()
boolean	isIgnoreDirFormatExtensions()
boolean	isIgnoreMissingDescriptor()
boolean	isIgnorePermissions()
boolean	isIncludeProjectBuildFilters()
boolean	isUpdateOnly()
boolean	isUseJvmChmod()
static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	mainProjectInterpolator(org.apache.maven.project.MavenProject mainProject)
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
void	setDelimiters(List<String> delimiters)
void	setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)
void	setTempRoot(File tempRoot)

Methods inherited from class br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

addMavenArtifactSet, addScope, calculateContainerConfigurationFileOutputPath, createDefaultDirectories, doBeforeSkipMojo, getBaseContainerConfigurationFileUrl, getBundleValidArtifactFilter, getCacheDirectory, getConfiguratorInitialFile, getContainer, getContainerCacheDirectory, getContainerPomDependenciesGAV, getContainerWorkDirectory, getDefaultSupportedPackagings, getExcludedArtifacts, getLocalRepositoryGAV, getLogbackConfigurationFile, getMavenArtifactSets, getMsgChoiceArtifact, getProjectBuilder, getScopes, isOptionalConsidered, isRunOnlyAtExecutionRoot, isSkip, isSkipConfigurationGen, isTransitiveConsidered, loadProperties, setBaseContainerConfigurationFileUrl, setConfiguratorInitialFile, setContainerPomDependenciesGAV, setEncoding, setLocalRepositoryGAV, setLogbackConfigurationFile, setScopes, setSkipConfigurationGen

Methods inherited from class br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

addExtraSupportedPackaging, cleanWorkDirectory, combineScopes, copyInternalFileToProjectDir, copyInternalFileToProjectDir, execute, getBasedir, getBuildDir, getCachedFileNamePattern, getCacheSubDirectory, getClassifier, getDependenciesHelper, getDirectoryHelper, getExtraSupportedPackagings, getFilterFactory, getFinalName, getGoalName, getLocalRepository, getMavenSession, getPluginDescriptor, getProject, getProjectHelper, getRemoteRepositories, getRepositorySystem, getRuntimeInformation, getSupportedPackagings, getWorkDirectory, getWorkSubDirectory, isAggregator, isVerbose, loadProject, loadProject, registerArtifactsIntoAggregatorBuildContext, setBuildDir, setClassifier, setExtraSupportedPackagings, setFinalName, setWorkDirectory

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

Methods inherited from interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getBasedir, getFinalName, getLocalRepository, getMavenSession, getProject, getRemoteRepositories

Field Detail

commandLinePropertiesInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator commandLinePropertiesInterpolator

envInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator envInterpolator

mainProjectInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator mainProjectInterpolator

rootInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator rootInterpolator

Constructor Detail

MojoGenerateOsgiAssemblyArchive

@Inject
public MojoGenerateOsgiAssemblyArchive(org.apache.maven.project.MavenProject project)

Method Detail

mainProjectInterpolator

public static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator mainProjectInterpolator(org.apache.maven.project.MavenProject mainProject)

executeExtraInitializationSteps

protected void executeExtraInitializationSteps()
                                        throws org.apache.maven.plugin.MojoExecutionException

Overrides:

executeExtraInitializationSteps in class AbstractOsgiContainerPackMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

doInitialValidation

protected boolean doInitialValidation()
                               throws org.apache.maven.plugin.MojoExecutionException

Overrides:

doInitialValidation in class br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

executeMojo

protected void executeMojo()
                    throws org.apache.maven.plugin.MojoExecutionException,
                           org.apache.maven.plugin.MojoFailureException

Overrides:

executeMojo in class br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getArchiveBaseDirectory

public File getArchiveBaseDirectory()

Specified by:

getArchiveBaseDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getArchiverConfig

public String getArchiverConfig()

Specified by:

getArchiverConfig in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getAssemblyArchiver

public org.apache.maven.plugins.assembly.archive.AssemblyArchiver getAssemblyArchiver()

getAssemblyReader

public org.apache.maven.plugins.assembly.io.AssemblyReader getAssemblyReader()

getCommandLinePropsInterpolator

@Nonnull
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getCommandLinePropsInterpolator()

Specified by:

getCommandLinePropsInterpolator in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getDelimiters

public List<String> getDelimiters()

Specified by:

getDelimiters in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getDescriptorReferences

public String[] getDescriptorReferences()

Specified by:

getDescriptorReferences in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getDescriptors

public String[] getDescriptors()

Specified by:

getDescriptors in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getDescriptorSourceDirectory

public File getDescriptorSourceDirectory()

Specified by:

getDescriptorSourceDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

Overrides:

getEncoding in class AbstractOsgiContainerPackMojo

getEnvInterpolator

@Nonnull
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getEnvInterpolator()

Specified by:

getEnvInterpolator in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getEscapeString

public String getEscapeString()

Specified by:

getEscapeString in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getFilters

public List<String> getFilters()

Specified by:

getFilters in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getJarArchiveConfiguration

public org.apache.maven.archiver.MavenArchiveConfiguration getJarArchiveConfiguration()

Specified by:

getJarArchiveConfiguration in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getMainProjectInterpolator

@Nonnull
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getMainProjectInterpolator()

Specified by:

getMainProjectInterpolator in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getMavenReaderFilter

public org.apache.maven.shared.filtering.MavenReaderFilter getMavenReaderFilter()

Specified by:

getMavenReaderFilter in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getMergeManifestMode

public String getMergeManifestMode()

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getReactorProjects

public List<org.apache.maven.project.MavenProject> getReactorProjects()

Specified by:

getReactorProjects in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getRepositoryInterpolator

@Nonnull
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getRepositoryInterpolator()

Specified by:

getRepositoryInterpolator in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getSiteDirectory

public File getSiteDirectory()

Specified by:

getSiteDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getTarLongFileMode

public String getTarLongFileMode()

Specified by:

getTarLongFileMode in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getTemporaryRootDirectory

public File getTemporaryRootDirectory()

Specified by:

getTemporaryRootDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isAssemblyIdAppended

public boolean isAssemblyIdAppended()

Specified by:

isAssemblyIdAppended in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isIgnoreDirFormatExtensions

public boolean isIgnoreDirFormatExtensions()

Specified by:

isIgnoreDirFormatExtensions in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isIgnoreMissingDescriptor

public boolean isIgnoreMissingDescriptor()

Specified by:

isIgnoreMissingDescriptor in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isIgnorePermissions

public boolean isIgnorePermissions()

Specified by:

isIgnorePermissions in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isIncludeProjectBuildFilters

public boolean isIncludeProjectBuildFilters()

Specified by:

isIncludeProjectBuildFilters in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isUpdateOnly

public boolean isUpdateOnly()

Specified by:

isUpdateOnly in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

setArchive

public void setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)

setDelimiters

public void setDelimiters(List<String> delimiters)

setReactorProjects

public void setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)

setTempRoot

public void setTempRoot(File tempRoot)