Class DeployFileMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.deploy.AbstractDeployMojo
org.apache.maven.plugins.deploy.DeployFileMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="deploy-file", requiresProject=false, threadSafe=true) public class DeployFileMojo extends AbstractDeployMojo
Installs the artifact in the remote repository.

  • Field Details

    • artifactDeployer

      @Component private org.apache.maven.shared.transfer.artifact.deploy.ArtifactDeployer artifactDeployer

    • projectHelper

      @Component private org.apache.maven.project.MavenProjectHelper projectHelper
      Used for attaching the artifacts to deploy to the project.

    • projectBuilder

      @Component private org.apache.maven.project.ProjectBuilder projectBuilder
      Used for creating the project to which the artifacts to deploy will be attached.

    • groupId

      @Parameter(property="groupId") private String groupId
      GroupId of the artifact to be deployed. Retrieved from POM file if specified.

    • artifactId

      @Parameter(property="artifactId") private String artifactId
      ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.

    • version

      @Parameter(property="version") private String version
      Version of the artifact to be deployed. Retrieved from POM file if specified.

    • packaging

      @Parameter(property="packaging") private String packaging
      Type of the artifact to be deployed. Retrieved from the <packaginginvalid input: '&gt' element of the POM file if a POM file specified. Defaults to the file extension if it is not specified via command line or POM.
      Maven uses two terms to refer to this datum: the <packaging> element for the entire POM, and the <type> element in a dependency specification.

    • description

      @Parameter(property="generatePom.description") private String description
      Description passed to a generated POM file (in case of generatePom=true)

    • file

      @Parameter(property="file", required=true) private File file
      File to be deployed.

    • javadoc

      @Parameter(property="javadoc") private File javadoc
      The bundled API docs for the artifact.
      Since:
      2.6

    • sources

      @Parameter(property="sources") private File sources
      The bundled sources for the artifact.
      Since:
      2.6

    • repositoryId

      @Parameter(property="repositoryId", defaultValue="remote-repository", required=true) private String repositoryId
      Server Id to map on the <id> under <server> section of settings.xml In most cases, this parameter will be required for authentication.

    • url

      @Parameter(property="url", required=true) private String url
      URL where the artifact will be deployed.
      ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )

    • pomFile

      @Parameter(property="pomFile") private File pomFile
      Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.

    • generatePom

      @Parameter(property="generatePom", defaultValue="true") private boolean generatePom
      Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.

    • classifier

      @Parameter(property="classifier") private String classifier
      Add classifier to the artifact

    • uniqueVersion

      @Parameter(property="uniqueVersion") @Deprecated private Boolean uniqueVersion
      Deprecated.
      As of Maven 3, this isn't supported anymore and this parameter is only present to break the build if you use it!
      Whether to deploy snapshots with a unique version or not.

    • types

      @Parameter(property="types") private String types
      A comma separated list of types for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or classifiers, then an error will be raised.

    • classifiers

      @Parameter(property="classifiers") private String classifiers
      A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or types, then an error will be raised.

    • files

      @Parameter(property="files") private String files
      A comma separated list of files for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in types or classifiers, then an error will be raised.

    • repoManager

      @Component private org.apache.maven.shared.transfer.repository.RepositoryManager repoManager

  • Constructor Details

    • DeployFileMojo

      public DeployFileMojo()

  • Method Details

    • initProperties

      void initProperties() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • execute

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

    • createMavenProject

      private org.apache.maven.project.MavenProject createMavenProject() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Creates a Maven project in-memory from the user-supplied groupId, artifactId and version. When a classifier is supplied, the packaging must be POM because the project with only have attachments. This project serves as basis to attach the artifacts to deploy to.
      Returns:
      The created Maven project, never null.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - When the model of the project could not be built.
      org.apache.maven.plugin.MojoFailureException - When building the project failed.

    • getLocalRepoFile

      private File getLocalRepoFile()
      Gets the path of the artifact constructed from the supplied groupId, artifactId, version, classifier and packaging within the local repository. Note that the returned path need not exist (yet).
      Returns:
      The absolute path to the artifact when installed, never null.

    • processModel

      private void processModel(org.apache.maven.model.Model model)
      Process the supplied pomFile to get groupId, artifactId, version, and packaging
      Parameters:
      model - The POM to extract missing artifact coordinates from, must not be null.

    • readModel

      org.apache.maven.model.Model readModel(File pomFile) throws org.apache.maven.plugin.MojoExecutionException
      Extract the model from the specified POM file.
      Parameters:
      pomFile - The path of the POM file to parse, must not be null.
      Returns:
      The model from the POM file, never null.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - If the file doesn't exist of cannot be read.

    • generatePomFile

      private File generatePomFile() throws org.apache.maven.plugin.MojoExecutionException
      Generates a minimal POM from the user-supplied artifact information.
      Returns:
      The path to the generated POM file, never null.
      Throws:
      org.apache.maven.plugin.MojoExecutionException - If the generation failed.

    • generateModel

      private org.apache.maven.model.Model generateModel()
      Generates a minimal model from the user-supplied artifact information.
      Returns:
      The generated model, never null.

    • setGroupId

      void setGroupId(String groupId)

    • setArtifactId

      void setArtifactId(String artifactId)

    • setVersion

      void setVersion(String version)

    • setPackaging

      void setPackaging(String packaging)

    • setPomFile

      void setPomFile(File pomFile)

    • getGroupId

      String getGroupId()

    • getArtifactId

      String getArtifactId()

    • getVersion

      String getVersion()

    • getPackaging

      String getPackaging()

    • getFile

      File getFile()

    • getClassifier

      String getClassifier()

    • setClassifier

      void setClassifier(String classifier)