package org.apache.maven.plugin.plugin.metadata;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.metadata.ArtifactRepositoryMetadata;
import org.apache.maven.artifact.repository.metadata.GroupRepositoryMetadata;
import org.apache.maven.artifact.repository.metadata.Versioning;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.project.MavenProject;
/**
* Inject any plugin-specific
* <a href="/ref/current/maven-repository-metadata/repository-metadata.html">artifact metadata</a> to the project's
* artifact, for subsequent installation and deployment.
* It is used:
* <ol>
* <li>to add the <code>latest</code> metadata (which is plugin-specific) for shipping alongside the plugin's artifact</li>
* <li>to define plugin mapping in the group</li>
* </ol>
*
* @see ArtifactRepositoryMetadata
* @see GroupRepositoryMetadata
* @version $Id: AddPluginArtifactMetadataMojo.java 1337501 2012-05-12 10:29:14Z olamy $
* @since 2.0
* @phase package
* @goal addPluginArtifactMetadata
* @threadSafe
*/
public class AddPluginArtifactMetadataMojo
extends AbstractMojo
{
/**
* The project artifact, which should have the <code>latest</code> metadata added to it.
*
* @parameter default-value="${project}"
* @required
* @readonly
*/
private MavenProject project;
/**
* The prefix for the plugin goal.
*
* @parameter
*/
private String goalPrefix;
/**
* Set this to "true" to skip invoking any goals or reports of the plugin.
*
* @parameter default-value="false" expression="${maven.plugin.skip}"
* @since 2.8
*/
private boolean skip;
/** {@inheritDoc} */
public void execute()
throws MojoExecutionException
{
if ( skip )
{
getLog().warn( "Execution skipped" );
return;
}
Artifact projectArtifact = project.getArtifact();
Versioning versioning = new Versioning();
versioning.setLatest( projectArtifact.getVersion() );
versioning.updateTimestamp();
ArtifactRepositoryMetadata metadata = new ArtifactRepositoryMetadata( projectArtifact, versioning );
projectArtifact.addMetadata( metadata );
GroupRepositoryMetadata groupMetadata = new GroupRepositoryMetadata( project.getGroupId() );
groupMetadata.addPluginMapping( getGoalPrefix(), project.getArtifactId(), project.getName() );
projectArtifact.addMetadata( groupMetadata );
}
/**
* @return the goal prefix parameter or the goal prefix from the Plugin artifactId.
*/
private String getGoalPrefix()
{
if ( goalPrefix == null )
{
goalPrefix = PluginDescriptor.getGoalPrefixFromArtifactId( project.getArtifactId() );
}
return goalPrefix;
}
}