Package org.apache.maven.plugins.dependency

Class GetMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="get",
      requiresProject=false,
      threadSafe=true)
public class GetMojo
extends org.apache.maven.plugin.AbstractMojo
    Resolves a single artifact, eventually transitively, from the specified remote repositories. Caveat: will always check the central repository defined in the super pom. You could use a mirror entry in your settings.xml

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.util.regex.Pattern ALT_REPO_SYNTAX_PATTERN  
      private java.lang.String artifact
      A string of the form groupId:artifactId:version[:packaging[:classifier]].
      private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager  
      private org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver  
      private org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate coordinate  
      private org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver  
      private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> pomRemoteRepositories  
      private java.lang.String remoteRepositories
      Repositories in the format id::[layout]::url or just url, separated by comma.
      private java.util.Map<java.lang.String,​org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts
      Map that contains the layouts.
      private org.apache.maven.repository.RepositorySystem repositorySystem
      The repository system.
      private org.apache.maven.execution.MavenSession session  
      private boolean skip
      Skip plugin execution completely.
      private boolean transitive
      Resolve transitively, retrieving the specified artifact and all of its dependencies.

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

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      GetMojo​(org.apache.maven.execution.MavenSession session, org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver, org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, java.util.Map<java.lang.String,​org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts, org.apache.maven.repository.RepositorySystem repositorySystem)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()  
      private org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout getLayout​(java.lang.String id)  
      protected boolean isSkip()  
      (package private) org.apache.maven.artifact.repository.ArtifactRepository parseRepository​(java.lang.String repo, org.apache.maven.artifact.repository.ArtifactRepositoryPolicy policy)  
      void setArtifactId​(java.lang.String artifactId)
      The artifactId of the artifact to resolve.
      void setClassifier​(java.lang.String classifier)
      The classifier of the artifact to resolve.
      void setGroupId​(java.lang.String groupId)
      The groupId of the artifact to resolve.
      void setPackaging​(java.lang.String type)
      The packaging of the artifact to resolve.
      void setVersion​(java.lang.String version)
      The version of the artifact to resolve.
      private org.apache.maven.shared.transfer.artifact.ArtifactCoordinate toArtifactCoordinate​(org.apache.maven.shared.transfer.dependencies.DependableCoordinate dependableCoordinate)  

      • 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

      • ALT_REPO_SYNTAX_PATTERN

        private static final java.util.regex.Pattern ALT_REPO_SYNTAX_PATTERN

      • session

        private final org.apache.maven.execution.MavenSession session

      • artifactResolver

        private final org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver

      • dependencyResolver

        private final org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver

      • artifactHandlerManager

        private final org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager

      • repositoryLayouts

        private final java.util.Map<java.lang.String,​org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts
        Map that contains the layouts.

      • repositorySystem

        private final org.apache.maven.repository.RepositorySystem repositorySystem
        The repository system.

      • coordinate

        private final org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate coordinate

      • remoteRepositories

        @Parameter(property="remoteRepositories")
private java.lang.String remoteRepositories
        Repositories in the format id::[layout]::url or just url, separated by comma. ie. central::default::https://repo.maven.apache.org/maven2,myrepo::::https://repo.acme.com,https://repo.acme2.com.

      • artifact

        @Parameter(property="artifact")
private java.lang.String artifact
        A string of the form groupId:artifactId:version[:packaging[:classifier]].

      • pomRemoteRepositories

        @Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true,
           required=true)
private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> pomRemoteRepositories

      • transitive

        @Parameter(property="transitive",
           defaultValue="true")
private boolean transitive
        Resolve transitively, retrieving the specified artifact and all of its dependencies.

      • skip

        @Parameter(property="mdep.skip",
           defaultValue="false")
private boolean skip
        Skip plugin execution completely.
        Since:
        2.7

    • Constructor Detail

      • GetMojo

        @Inject
public GetMojo​(org.apache.maven.execution.MavenSession session,
               org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver artifactResolver,
               org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver,
               org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
               java.util.Map<java.lang.String,​org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts,
               org.apache.maven.repository.RepositorySystem repositorySystem)

    • Method Detail

      • 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

      • toArtifactCoordinate

        private org.apache.maven.shared.transfer.artifact.ArtifactCoordinate toArtifactCoordinate​(org.apache.maven.shared.transfer.dependencies.DependableCoordinate dependableCoordinate)

      • parseRepository

        org.apache.maven.artifact.repository.ArtifactRepository parseRepository​(java.lang.String repo,
                                                                        org.apache.maven.artifact.repository.ArtifactRepositoryPolicy policy)
                                                                 throws org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoFailureException

      • getLayout

        private org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout getLayout​(java.lang.String id)
                                                                                throws org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoFailureException

      • isSkip

        protected boolean isSkip()
        Returns:
        skip

      • setGroupId

        @Parameter(property="groupId")
public void setGroupId​(java.lang.String groupId)
        The groupId of the artifact to resolve. Ignored if artifact is used.
        Parameters:
        groupId - the groupId

      • setArtifactId

        @Parameter(property="artifactId")
public void setArtifactId​(java.lang.String artifactId)
        The artifactId of the artifact to resolve. Ignored if artifact is used.
        Parameters:
        artifactId - the artifactId

      • setVersion

        @Parameter(property="version")
public void setVersion​(java.lang.String version)
        The version of the artifact to resolve. Ignored if artifact is used.
        Parameters:
        version - the version

      • setClassifier

        @Parameter(property="classifier")
public void setClassifier​(java.lang.String classifier)
        The classifier of the artifact to resolve. Ignored if artifact is used.
        Parameters:
        classifier - the classifier to be used
        Since:
        2.3

      • setPackaging

        @Parameter(property="packaging",
           defaultValue="jar")
public void setPackaging​(java.lang.String type)
        The packaging of the artifact to resolve. Ignored if artifact is used.
        Parameters:
        type - packaging