org.apache.maven.plugin.eclipse

Class EclipseToMavenMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.eclipse.EclipseToMavenMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

MakeArtifactsMojo

public class EclipseToMavenMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Add eclipse artifacts from an eclipse installation to the local repo. This mojo automatically analize the eclipse directory, copy plugins jars to the local maven repo, and generates appropriate poms. This is the official central repository builder for Eclipse plugins, so it has the necessary default values. For customized repositories see MakeArtifactsMojo Typical usage: mvn eclipse:to-maven -DdeployTo=maven.org::default::scpexe://repo1.maven.org/home/maven/repository-staging/to-ibiblio/eclipse-staging -DeclipseDir=.

Version:

$Id: EclipseToMavenMojo.java 1154368 2011-08-05 20:13:42Z rfscholte $

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory ArtifactFactory component.
private org.apache.maven.artifact.repository.ArtifactRepositoryFactory	artifactRepositoryFactory ArtifactRepositoryFactory component.
private org.codehaus.plexus.PlexusContainer	container Plexus container, needed to manually lookup components for deploy of artifacts.
private org.apache.maven.artifact.deployer.ArtifactDeployer	deployer ArtifactDeployer component.
private java.lang.String	deployTo Specifies a remote repository to which generated artifacts should be deployed to.
private static java.util.regex.Pattern	DEPLOYTO_PATTERN A pattern the deployTo param should match.
private java.io.File	eclipseDir Eclipse installation dir.
protected org.codehaus.plexus.components.interactivity.InputHandler	inputHandler Input handler, needed for comand line handling.
protected org.apache.maven.artifact.installer.ArtifactInstaller	installer ArtifactInstaller component.
private org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local maven repository.
private boolean	stripQualifier Strip qualifier (fourth token) from the plugin version.
private static java.util.regex.Pattern	VERSION_PATTERN A pattern for a 4 digit osgi version number.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
EclipseToMavenMojo()

Method Summary

Modifier and Type	Method and Description
void	contextualize(org.codehaus.plexus.context.Context context)
protected java.lang.String	createArtifactId(java.lang.String bundleName) Get the artifact id as the tokens after last dot e.g.
protected java.lang.String	createGroupId(java.lang.String bundleName) Get the group id as the tokens until last dot e.g.
private org.apache.maven.model.Model	createModel(EclipseOsgiPlugin plugin) Create the Model from a plugin manifest
void	execute()
protected java.lang.String	fixBuildNumberSeparator(java.lang.String versionRange) Fix the separator for the 4th token in a versions.
private EclipseOsgiPlugin	getEclipsePlugin(java.io.File file) Get a EclipseOsgiPlugin object from a plugin jar/dir found in the target dir.
private java.lang.String	getKey(org.apache.maven.model.Dependency dependency)
protected java.lang.String	getKey(org.apache.maven.model.Model model)
protected java.lang.String	osgiVersionToMavenVersion(java.lang.String version)
protected java.lang.String	osgiVersionToMavenVersion(java.lang.String version, java.lang.String forcedQualifier, boolean stripQualifier) The 4th (build) token MUST be separed with "-" and not with "." in maven.
protected org.apache.maven.model.Dependency[]	parseDependencies(java.lang.String requireBundle) Parses the "Require-Bundle" and convert it to a list of dependencies.
protected void	processFile(java.io.File file, java.util.Map plugins, java.util.Map models)
protected void	processPlugin(EclipseOsgiPlugin plugin, org.apache.maven.model.Model model, java.util.Map plugins, java.util.Map models)
private org.apache.maven.artifact.repository.ArtifactRepository	resolveRemoteRepo() Resolves the deploydeployTo parameter to an ArtifactRepository instance (if set).
protected void	resolveVersionRanges(org.apache.maven.model.Model model, java.util.Map models) Resolve version ranges in the model provided, overriding version ranges with versions from the dependency in the provided map of models.
private void	writeArtifact(EclipseOsgiPlugin plugin, org.apache.maven.model.Model model, org.apache.maven.artifact.repository.ArtifactRepository remoteRepo) Writes the artifact to the repo

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

DEPLOYTO_PATTERN

private static final java.util.regex.Pattern DEPLOYTO_PATTERN

A pattern the deployTo param should match.

VERSION_PATTERN

private static final java.util.regex.Pattern VERSION_PATTERN

A pattern for a 4 digit osgi version number.

container

private org.codehaus.plexus.PlexusContainer container

Plexus container, needed to manually lookup components for deploy of artifacts.

localRepository

private org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local maven repository.

artifactRepositoryFactory

private org.apache.maven.artifact.repository.ArtifactRepositoryFactory artifactRepositoryFactory

ArtifactRepositoryFactory component.

artifactFactory

private org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

ArtifactFactory component.

installer

protected org.apache.maven.artifact.installer.ArtifactInstaller installer

ArtifactInstaller component.

deployer

private org.apache.maven.artifact.deployer.ArtifactDeployer deployer

ArtifactDeployer component.

eclipseDir

private java.io.File eclipseDir

Eclipse installation dir. If not set, a value for this parameter will be asked on the command line.

inputHandler

protected org.codehaus.plexus.components.interactivity.InputHandler inputHandler

Input handler, needed for comand line handling.

stripQualifier

private boolean stripQualifier

Strip qualifier (fourth token) from the plugin version. Qualifiers are for eclipse plugin the equivalent of timestamped snapshot versions for Maven, but the date is maintained also for released version (e.g. a jar for the release 3.2 can be named org.eclipse.core.filesystem_1.0.0.v20060603.jar. It's usually handy to not to include this qualifier when generating maven artifacts for major releases, while it's needed when working with eclipse integration/nightly builds.

deployTo

private java.lang.String deployTo

Specifies a remote repository to which generated artifacts should be deployed to. If this property is specified, artifacts are also deployed to the remote repo. The format for this parameter is id::layout::url

Constructor Detail

EclipseToMavenMojo

public EclipseToMavenMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

processFile

protected void processFile(java.io.File file,
                           java.util.Map plugins,
                           java.util.Map models)
                    throws org.apache.maven.plugin.MojoExecutionException,
                           org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processPlugin

protected void processPlugin(EclipseOsgiPlugin plugin,
                             org.apache.maven.model.Model model,
                             java.util.Map plugins,
                             java.util.Map models)
                      throws org.apache.maven.plugin.MojoExecutionException,
                             org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getKey

protected java.lang.String getKey(org.apache.maven.model.Model model)

getKey

private java.lang.String getKey(org.apache.maven.model.Dependency dependency)

resolveVersionRanges

protected void resolveVersionRanges(org.apache.maven.model.Model model,
                                    java.util.Map models)
                             throws org.apache.maven.plugin.MojoFailureException

Resolve version ranges in the model provided, overriding version ranges with versions from the dependency in the provided map of models. TODO doesn't check if the version is in range, it just overwrites it

Parameters:

model -

models -

Throws:

org.apache.maven.plugin.MojoFailureException

getEclipsePlugin

private EclipseOsgiPlugin getEclipsePlugin(java.io.File file)
                                    throws org.apache.maven.plugin.MojoExecutionException

Get a EclipseOsgiPlugin object from a plugin jar/dir found in the target dir.

Parameters:

file - plugin jar or dir

Throws:

org.apache.maven.plugin.MojoExecutionException - if anything bad happens while parsing files

createModel

private org.apache.maven.model.Model createModel(EclipseOsgiPlugin plugin)
                                          throws org.apache.maven.plugin.MojoExecutionException

Create the Model from a plugin manifest

Parameters:

plugin - Eclipse plugin jar or dir

Throws:

org.apache.maven.plugin.MojoExecutionException - if anything bad happens while parsing files

writeArtifact

private void writeArtifact(EclipseOsgiPlugin plugin,
                           org.apache.maven.model.Model model,
                           org.apache.maven.artifact.repository.ArtifactRepository remoteRepo)
                    throws org.apache.maven.plugin.MojoExecutionException

Writes the artifact to the repo

Parameters:

model -

remoteRepo - remote repository (if set)

Throws:

org.apache.maven.plugin.MojoExecutionException

osgiVersionToMavenVersion

protected java.lang.String osgiVersionToMavenVersion(java.lang.String version)

osgiVersionToMavenVersion

protected java.lang.String osgiVersionToMavenVersion(java.lang.String version,
                                                     java.lang.String forcedQualifier,
                                                     boolean stripQualifier)

The 4th (build) token MUST be separed with "-" and not with "." in maven. A version with 4 dots is not parsed, and the whole string is considered a qualifier. See tests in DefaultArtifactVersion for reference.

Parameters:

version - initial version

forcedQualifier - build number

stripQualifier - always remove 4th token in version

Returns:

converted version

resolveRemoteRepo

private org.apache.maven.artifact.repository.ArtifactRepository resolveRemoteRepo()
                                                                           throws org.apache.maven.plugin.MojoFailureException,
                                                                                  org.apache.maven.plugin.MojoExecutionException

Resolves the deploydeployTo parameter to an ArtifactRepository instance (if set).

Returns:

ArtifactRepository instance of null if deployTo is not set.

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

createGroupId

protected java.lang.String createGroupId(java.lang.String bundleName)

Get the group id as the tokens until last dot e.g. org.eclipse.jdt -> org.eclipse

Parameters:

bundleName - bundle name

Returns:

group id

createArtifactId

protected java.lang.String createArtifactId(java.lang.String bundleName)

Get the artifact id as the tokens after last dot e.g. org.eclipse.jdt -> jdt

Parameters:

bundleName - bundle name

Returns:

artifact id

parseDependencies

protected org.apache.maven.model.Dependency[] parseDependencies(java.lang.String requireBundle)

Parses the "Require-Bundle" and convert it to a list of dependencies.

Parameters:

requireBundle - "Require-Bundle" entry

Returns:

an array of Dependency

fixBuildNumberSeparator

protected java.lang.String fixBuildNumberSeparator(java.lang.String versionRange)

Fix the separator for the 4th token in a versions. In maven this must be "-", in OSGI it's "."

Parameters:

versionRange - input range

Returns:

modified version range