Class RepositoryTool

  • All Implemented Interfaces:
    org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

    @Deprecated
    @Component(role=RepositoryTool.class)
    public class RepositoryTool
    extends java.lang.Object
    implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
    Deprecated.
    Tools to access and manage Maven repositories for test builds, including construction of a local repository directory structure.

    WARNING: Currently, the createLocalRepositoryFromPlugin method will not resolve parent POMs that exist only in your normal local repository, and are not reachable using the relativePath element. This may result in failed test builds, as one or more of the plugin's ancestor POMs cannot be resolved.

    Version:
    $Id$
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
      Deprecated.
       
      private org.apache.maven.artifact.installer.ArtifactInstaller artifactInstaller
      Deprecated.
       
      private org.codehaus.plexus.PlexusContainer container
      Deprecated.
       
      private org.apache.maven.plugin.LegacySupport legacySupport
      Deprecated.
       
      private org.apache.maven.artifact.repository.ArtifactRepositoryFactory repositoryFactory
      Deprecated.
       
      static java.lang.String ROLE
      Deprecated.
      Plexus role
      private org.apache.maven.settings.MavenSettingsBuilder settingsBuilder
      Deprecated.
       
    • Constructor Summary

      Constructors 
      Constructor Description
      RepositoryTool()
      Deprecated.
       
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void contextualize​(org.codehaus.plexus.context.Context context)
      Deprecated.
      Retrieve the PlexusContainer instance used to instantiate this component.
      org.apache.maven.artifact.repository.ArtifactRepository createLocalArtifactRepositoryInstance()
      Deprecated.
      Construct an ArtifactRepository instance that refers to the normal Maven local repository.
      org.apache.maven.artifact.repository.ArtifactRepository createLocalArtifactRepositoryInstance​(java.io.File localRepositoryDirectory)
      Deprecated.
      Construct an ArtifactRepository instance that refers to the test-time Maven local repository.
      void createLocalRepositoryFromComponentProject​(org.apache.maven.project.MavenProject project, java.io.File realPomFile, java.io.File targetLocalRepoBasedir)
      Deprecated.
      Install a test version of a plugin - along with its POM, and as many ancestor POMs as can be reached using the <relativePath/> element - to a clean local repository directory for use in test builds.
      java.io.File findLocalRepositoryDirectory()
      Deprecated.
      Lookup and return the location of the normal Maven local repository.
      private void installLocallyReachableAncestorPoms​(java.io.File realPomFile, org.apache.maven.artifact.repository.ArtifactRepository localRepo)
      Deprecated.
      Traverse <relativePath/> links for successive POMs in the plugin's ancestry, installing each one into the test-time local repository.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • ROLE

        public static final java.lang.String ROLE
        Deprecated.
        Plexus role
      • repositoryFactory

        @Requirement
        private org.apache.maven.artifact.repository.ArtifactRepositoryFactory repositoryFactory
        Deprecated.
      • settingsBuilder

        @Requirement
        private org.apache.maven.settings.MavenSettingsBuilder settingsBuilder
        Deprecated.
      • artifactFactory

        @Requirement
        private org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
        Deprecated.
      • artifactInstaller

        @Requirement
        private org.apache.maven.artifact.installer.ArtifactInstaller artifactInstaller
        Deprecated.
      • legacySupport

        @Requirement
        private org.apache.maven.plugin.LegacySupport legacySupport
        Deprecated.
      • container

        private org.codehaus.plexus.PlexusContainer container
        Deprecated.
    • Constructor Detail

      • RepositoryTool

        public RepositoryTool()
        Deprecated.
    • Method Detail

      • findLocalRepositoryDirectory

        public java.io.File findLocalRepositoryDirectory()
                                                  throws TestToolsException
        Deprecated.
        Lookup and return the location of the normal Maven local repository.
        Returns:
        the location of the normal Maven local repository.
        Throws:
        TestToolsException - if any
      • createLocalArtifactRepositoryInstance

        public org.apache.maven.artifact.repository.ArtifactRepository createLocalArtifactRepositoryInstance()
                                                                                                      throws TestToolsException
        Deprecated.
        Construct an ArtifactRepository instance that refers to the normal Maven local repository.
        Returns:
        an ArtifactRepository instance
        Throws:
        TestToolsException - if any
      • createLocalArtifactRepositoryInstance

        public org.apache.maven.artifact.repository.ArtifactRepository createLocalArtifactRepositoryInstance​(java.io.File localRepositoryDirectory)
                                                                                                      throws TestToolsException
        Deprecated.
        Construct an ArtifactRepository instance that refers to the test-time Maven local repository.
        Parameters:
        localRepositoryDirectory - The location of the local repository to be used for test builds.
        Returns:
        an ArtifactRepository instance
        Throws:
        TestToolsException - if any
      • createLocalRepositoryFromComponentProject

        public void createLocalRepositoryFromComponentProject​(org.apache.maven.project.MavenProject project,
                                                              java.io.File realPomFile,
                                                              java.io.File targetLocalRepoBasedir)
                                                       throws TestToolsException
        Deprecated.
        Install a test version of a plugin - along with its POM, and as many ancestor POMs as can be reached using the <relativePath/> element - to a clean local repository directory for use in test builds.

        WARNING: Currently, this method will not resolve parent POMs that exist only in your normal local repository, and are not reachable using the relativePath element. This may result in failed test builds, as one or more of the plugin's ancestor POMs cannot be resolved.

        Parameters:
        project -
        realPomFile -
        targetLocalRepoBasedir -
        Throws:
        TestToolsException - if any
      • installLocallyReachableAncestorPoms

        private void installLocallyReachableAncestorPoms​(java.io.File realPomFile,
                                                         org.apache.maven.artifact.repository.ArtifactRepository localRepo)
                                                  throws TestToolsException
        Deprecated.
        Traverse <relativePath/> links for successive POMs in the plugin's ancestry, installing each one into the test-time local repository.
        Parameters:
        realPomFile - The real plugin POM; a starting point, but the POM is already installed, so we won't actually install this file, only use it to locate parents.
        localRepo - The test-time local repository instance
        Throws:
        TestToolsException - if any
      • contextualize

        public void contextualize​(org.codehaus.plexus.context.Context context)
                           throws org.codehaus.plexus.context.ContextException
        Deprecated.
        Retrieve the PlexusContainer instance used to instantiate this component. The container is used to retrieve the default ArtifactRepositoryLayout component, for use in constructing instances of ArtifactRepository that can be used to access local repositories.
        Specified by:
        contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
        Throws:
        org.codehaus.plexus.context.ContextException
        See Also:
        Contextualizable.contextualize(org.codehaus.plexus.context.Context)