Class GetMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.dependency.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 final Pattern
    ALT_REPO_SYNTAX_PATTERN
     
    private String
    artifact
    A string of the form groupId:artifactId:version[:packaging[:classifier]].
    private final org.apache.maven.artifact.handler.manager.ArtifactHandlerManager
    artifactHandlerManager
     
    private final org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver
    artifactResolver
     
    private final org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate
    coordinate
     
    private final org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver
    dependencyResolver
     
    private List<org.apache.maven.artifact.repository.ArtifactRepository>
    pomRemoteRepositories
     
    private String
    remoteRepositories
    Repositories in the format id::[layout]::url or just url, separated by comma.
    private final Map<String, org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout>
    repositoryLayouts
    Map that contains the layouts.
    private final org.apache.maven.repository.RepositorySystem
    repositorySystem
    The repository system.
    private final 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, Map<String, org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts, org.apache.maven.repository.RepositorySystem repositorySystem)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
     
    private org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout
    getLayout(String id)
     
    protected boolean
    isSkip()
     
    (package private) org.apache.maven.artifact.repository.ArtifactRepository
    parseRepository(String repo, org.apache.maven.artifact.repository.ArtifactRepositoryPolicy policy)
     
    void
    setArtifactId(String artifactId)
    The artifactId of the artifact to resolve.
    void
    setClassifier(String classifier)
    The classifier of the artifact to resolve.
    void
    setGroupId(String groupId)
    The groupId of the artifact to resolve.
    void
    setPackaging(String type)
    The packaging of the artifact to resolve.
    void
    setVersion(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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ALT_REPO_SYNTAX_PATTERN

      private static final 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 Map<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 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 String artifact
      A string of the form groupId:artifactId:version[:packaging[:classifier]].

    • pomRemoteRepositories

      @Parameter(defaultValue="${project.remoteArtifactRepositories}", readonly=true, required=true) private 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 Details

    • 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, Map<String, org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout> repositoryLayouts, org.apache.maven.repository.RepositorySystem repositorySystem)

  • Method Details

    • 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(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(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(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(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(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(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(String type)
      The packaging of the artifact to resolve. Ignored if artifact is used.
      Parameters:
      type - packaging