org.apache.sling.maven.projectsupport
Class AbstractBundleListMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.sling.maven.projectsupport.AbstractBundleListMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractLaunchpadFrameworkMojo, AbstractLaunchpadStartingMojo, AttachBundleListMojo, CheckBundleListForSnapshotsMojo, CreateKarafFeatureDescriptorMojo, OutputBundleListMojo

public abstract class AbstractBundleListMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

protected java.io.File	bundleListFile
protected ArtifactDefinition	defaultBundleList The definition of the defaultBundleList artifact.
protected static java.lang.String	JAR JAR Packaging type.
protected org.apache.maven.execution.MavenSession	mavenSession
protected org.apache.maven.project.MavenProject	project The Maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected static java.lang.String	WAR WAR Packaging type.

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

ROLE

Constructor Summary

AbstractBundleListMojo()

Method Summary

void	execute()
protected abstract void	executeWithArtifacts() Execute the logic of the plugin after the default artifacts have been initialized.
protected org.apache.maven.artifact.Artifact	getArtifact(ArtifactDefinition def) Get a resolved Artifact from the coordinates found in the artifact definition.
protected org.apache.maven.artifact.Artifact	getArtifact(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String type, java.lang.String classifier) Get a resolved Artifact from the coordinates provided
protected BundleList	getBundleList()
protected void	initArtifactDefinitions(java.util.Properties dependencies) Hook methods for subclasses to initialize any additional artifact definitions.
protected void	initBundleList(BundleList bundleList) Hook methods for subclasses to initialize the bundle list.
protected boolean	isCurrentArtifact(ArtifactDefinition def)
protected static boolean	shouldCopy(java.io.File source, java.io.File dest)

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

JAR

protected static final java.lang.String JAR

JAR Packaging type.

See Also:

Constant Field Values

WAR

protected static final java.lang.String WAR

WAR Packaging type.

See Also:

Constant Field Values

bundleListFile

protected java.io.File bundleListFile

defaultBundleList

protected ArtifactDefinition defaultBundleList

The definition of the defaultBundleList artifact.

project

protected org.apache.maven.project.MavenProject project

The Maven project.

projectHelper

protected org.apache.maven.project.MavenProjectHelper projectHelper

mavenSession

protected org.apache.maven.execution.MavenSession mavenSession

Constructor Detail

AbstractBundleListMojo

public AbstractBundleListMojo()

Method Detail

shouldCopy

protected static boolean shouldCopy(java.io.File source,
                                    java.io.File dest)

execute

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

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

executeWithArtifacts

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

Execute the logic of the plugin after the default artifacts have been initialized.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getArtifact

protected org.apache.maven.artifact.Artifact getArtifact(ArtifactDefinition def)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Get a resolved Artifact from the coordinates found in the artifact definition.

Parameters:

def - the artifact definition

Returns:

the artifact, which has been resolved

Throws:

org.apache.maven.plugin.MojoExecutionException

getArtifact

protected org.apache.maven.artifact.Artifact getArtifact(java.lang.String groupId,
                                                         java.lang.String artifactId,
                                                         java.lang.String version,
                                                         java.lang.String type,
                                                         java.lang.String classifier)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Get a resolved Artifact from the coordinates provided

Returns:

the artifact, which has been resolved.

Throws:

org.apache.maven.plugin.MojoExecutionException

getBundleList

protected BundleList getBundleList()

initArtifactDefinitions

protected void initArtifactDefinitions(java.util.Properties dependencies)

Hook methods for subclasses to initialize any additional artifact definitions.

Parameters:

dependencies - the dependency properties loaded from the JAR file

initBundleList

protected void initBundleList(BundleList bundleList)

Hook methods for subclasses to initialize the bundle list.

isCurrentArtifact

protected boolean isCurrentArtifact(ArtifactDefinition def)