core-it-support/core-it-plugins/maven-it-plugin-artifact/src/main/java/org/apache/maven/plugin/coreit/DeployFileMojo.java

/*
 * 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.
 */
package org.apache.maven.plugin.coreit;

import java.io.File;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.deployer.ArtifactDeployer;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.repository.ArtifactRepositoryFactory;
import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

/**
 * Deploys a user-supplied file to some repository. This mimics part of the Maven Deploy Plugin.
 *
 * @author Benjamin Bentmann
 *
 */
@Mojo(name = "deploy-file", requiresProject = false)
public class DeployFileMojo extends AbstractMojo {

    /**
     * The file of the artifact to deploy.
     */
    @Parameter(property = "file")
    private File file;

    /**
     * The group id of the artifact.
     */
    @Parameter(property = "groupId")
    private String groupId;

    /**
     * The artifact id of the artifact.
     */
    @Parameter(property = "artifactId")
    private String artifactId;

    /**
     * The version of the artifact.
     */
    @Parameter(property = "version")
    private String version;

    /**
     * The URL of the repository to deploy to.
     */
    @Parameter(property = "repositoryUrl")
    private String repositoryUrl;

    /**
     * The ID of the repository to deploy to.
     */
    @Parameter(property = "repositoryId")
    private String repositoryId;

    /**
     * The repository factory.
     *
     */
    @Component
    private ArtifactRepositoryFactory repositoryFactory;

    /**
     * The repository layout.
     */
    @Component(hint = "default")
    private ArtifactRepositoryLayout repositoryLayout;

    /**
     * The artifact factory.
     *
     */
    @Component
    private ArtifactFactory artifactFactory;

    /**
     * The artifact deployer.
     *
     */
    @Component
    private ArtifactDeployer deployer;

    /**
     * The local repository.
     */
    @Parameter(defaultValue = "${localRepository}", readonly = true, required = true)
    private ArtifactRepository localRepository;

    /**
     * Runs this mojo.
     *
     * @throws MojoExecutionException If any artifact could not be deployed.
     */
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("[MAVEN-CORE-IT-LOG] Deploying artifacts");

        try {
            ArtifactRepository repository = repositoryFactory.createDeploymentArtifactRepository(
                    repositoryId, repositoryUrl, repositoryLayout, true);

            Artifact artifact = artifactFactory.createArtifact(groupId, artifactId, version, null, "jar");

            deployer.deploy(file, artifact, repository, localRepository);
        } catch (Exception e) {
            throw new MojoExecutionException("Failed to deploy artifacts: " + e.getMessage(), e);
        }
    }
}