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

Class AbstractOsgiContainerPackMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDockerMojo, MojoCacheMavenArtifacts, MojoGenerateContainerConfigFile, MojoGenerateOsgiAssemblyArchive

public abstract class AbstractOsgiContainerPackMojo
extends br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

Author:

Cristiano Gavião

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOWNLOAD_STATUS
static String	EQUINOX_CONFIGURATION_NAME
static String	EQUINOX_CONFIGURATION_PATH
static String	FELIX_CONFIGURATION_NAME
static String	FELIX_CONFIGURATION_PATH
protected static String	PROPERTY_CACHE_DIR
protected static String	PROPERTY_WORK_DIR

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOsgiContainerPackMojo(org.apache.maven.project.MavenProject project)
protected	AbstractOsgiContainerPackMojo(org.apache.maven.project.MavenProject project, String... packagings) The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addMavenArtifactSet(br.com.c8tech.tools.maven.osgi.lib.mojo.beans.MavenArtifactSet pMavenArtifactSet)
void	addScope(String scope)
protected Path	calculateContainerConfigurationFileOutputPath()
protected void	createDefaultDirectories()
protected void	doBeforeSkipMojo() Used to specify any action that must be executed when the mojo are being skipped by maven reactor.
protected void	executeExtraInitializationSteps()
protected String	getBaseContainerConfigurationFileUrl()
org.apache.maven.artifact.resolver.filter.ArtifactFilter	getBundleValidArtifactFilter()
Path	getCacheDirectory()
File	getConfiguratorInitialFile()
protected Container	getContainer()
protected Path	getContainerCacheDirectory()
protected String	getContainerPomDependenciesGAV()
protected Path	getContainerWorkDirectory()
static String[]	getDefaultSupportedPackagings()
String	getEncoding()
protected List<String>	getExcludedArtifacts()
String	getLocalRepositoryGAV()
File	getLogbackConfigurationFile()
protected br.com.c8tech.tools.maven.osgi.lib.mojo.beans.MavenArtifactSets	getMavenArtifactSets()
static MessageFormat	getMsgChoiceArtifact()
org.apache.maven.project.ProjectBuilder	getProjectBuilder()
protected Set<String>	getScopes()
protected boolean	isOptionalConsidered()
boolean	isRunOnlyAtExecutionRoot()
protected boolean	isSkip()
protected boolean	isSkipConfigurationGen()
protected boolean	isTransitiveConsidered()
static Properties	loadProperties(URL pPropertiesFileURL, String pEncoding)
protected void	setBaseContainerConfigurationFileUrl(String pBaseContainerConfigurationFileUrl)
void	setConfiguratorInitialFile(File pConfiguratorInitialFile)
protected void	setContainerPomDependenciesGAV(String pContainerPomDependenciesGAV)
void	setEncoding(String pEncoding)
void	setLocalRepositoryGAV(String pLocalRepositoryGAV)
void	setLogbackConfigurationFile(File pLogbackConfigurationFile)
void	setScopes(List<String> scopes)
protected void	setSkipConfigurationGen(boolean pSkipConfigurationGen)

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

addExtraSupportedPackaging, cleanWorkDirectory, combineScopes, copyInternalFileToProjectDir, copyInternalFileToProjectDir, doInitialValidation, execute, executeMojo, 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

Field Detail

DOWNLOAD_STATUS

public static final String DOWNLOAD_STATUS

See Also:

Constant Field Values

EQUINOX_CONFIGURATION_NAME

public static final String EQUINOX_CONFIGURATION_NAME

See Also:

Constant Field Values

EQUINOX_CONFIGURATION_PATH

public static final String EQUINOX_CONFIGURATION_PATH

See Also:

Constant Field Values

FELIX_CONFIGURATION_NAME

public static final String FELIX_CONFIGURATION_NAME

See Also:

Constant Field Values

FELIX_CONFIGURATION_PATH

public static final String FELIX_CONFIGURATION_PATH

See Also:

Constant Field Values

PROPERTY_CACHE_DIR

protected static final String PROPERTY_CACHE_DIR

See Also:

Constant Field Values

PROPERTY_WORK_DIR

protected static final String PROPERTY_WORK_DIR

See Also:

Constant Field Values

Constructor Detail

AbstractOsgiContainerPackMojo

protected AbstractOsgiContainerPackMojo(org.apache.maven.project.MavenProject project)

AbstractOsgiContainerPackMojo

protected AbstractOsgiContainerPackMojo(org.apache.maven.project.MavenProject project,
                                        String... packagings)

The default constructor.

Parameters:

project - the current project.

packagings - the packagings supported by the plugin.

Method Detail

getDefaultSupportedPackagings

public static String[] getDefaultSupportedPackagings()

getMsgChoiceArtifact

public static MessageFormat getMsgChoiceArtifact()

loadProperties

public static Properties loadProperties(URL pPropertiesFileURL,
                                        String pEncoding)
                                 throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addMavenArtifactSet

public final void addMavenArtifactSet(br.com.c8tech.tools.maven.osgi.lib.mojo.beans.MavenArtifactSet pMavenArtifactSet)

addScope

public final void addScope(String scope)

calculateContainerConfigurationFileOutputPath

protected final Path calculateContainerConfigurationFileOutputPath()

createDefaultDirectories

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

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

doBeforeSkipMojo

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

Used to specify any action that must be executed when the mojo are being skipped by maven reactor.

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException - When the skipping process had any problem

executeExtraInitializationSteps

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

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getBaseContainerConfigurationFileUrl

protected String getBaseContainerConfigurationFileUrl()

getBundleValidArtifactFilter

public org.apache.maven.artifact.resolver.filter.ArtifactFilter getBundleValidArtifactFilter()

getCacheDirectory

public final Path getCacheDirectory()

Specified by:

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

getConfiguratorInitialFile

public File getConfiguratorInitialFile()

getContainer

protected final Container getContainer()

getContainerCacheDirectory

protected final Path getContainerCacheDirectory()

getContainerPomDependenciesGAV

protected String getContainerPomDependenciesGAV()

getContainerWorkDirectory

protected final Path getContainerWorkDirectory()

getEncoding

public String getEncoding()

getExcludedArtifacts

protected final List<String> getExcludedArtifacts()

getLocalRepositoryGAV

public String getLocalRepositoryGAV()

getLogbackConfigurationFile

public File getLogbackConfigurationFile()

getMavenArtifactSets

protected final br.com.c8tech.tools.maven.osgi.lib.mojo.beans.MavenArtifactSets getMavenArtifactSets()

getProjectBuilder

public org.apache.maven.project.ProjectBuilder getProjectBuilder()

getScopes

protected final Set<String> getScopes()

isOptionalConsidered

protected final boolean isOptionalConsidered()

isRunOnlyAtExecutionRoot

public boolean isRunOnlyAtExecutionRoot()

isSkip

protected boolean isSkip()

Specified by:

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

isSkipConfigurationGen

protected boolean isSkipConfigurationGen()

isTransitiveConsidered

protected final boolean isTransitiveConsidered()

setBaseContainerConfigurationFileUrl

protected void setBaseContainerConfigurationFileUrl(String pBaseContainerConfigurationFileUrl)

setConfiguratorInitialFile

public void setConfiguratorInitialFile(File pConfiguratorInitialFile)

setContainerPomDependenciesGAV

protected void setContainerPomDependenciesGAV(String pContainerPomDependenciesGAV)

setEncoding

public void setEncoding(String pEncoding)

setLocalRepositoryGAV

public void setLocalRepositoryGAV(String pLocalRepositoryGAV)

setLogbackConfigurationFile

public void setLogbackConfigurationFile(File pLogbackConfigurationFile)

setScopes

public final void setScopes(List<String> scopes)

setSkipConfigurationGen

protected void setSkipConfigurationGen(boolean pSkipConfigurationGen)