Package org.apache.maven.archetype

Interface ArchetypeManager

All Known Implementing Classes:
DefaultArchetypeManager
public interface ArchetypeManager
Author:
Jason van Zyl

  • Field Details

    • ROLE

      static final String ROLE

  • Method Details

    • createArchetypeFromProject

      ArchetypeCreationResult createArchetypeFromProject(ArchetypeCreationRequest request)
      A command to create an archetype from an existing Maven project given the supplied creation request.
      Parameters:
      request -
      Returns:
      The result of creating the archetype from the existing project. It contains any errors that might have occurred.

    • generateProjectFromArchetype

      ArchetypeGenerationResult generateProjectFromArchetype(ArchetypeGenerationRequest request)
      A command to generate a Maven project from an archetype given the supplied generation request.
      Parameters:
      request -
      Returns:
      The result of creating the project from the existing archetype. It contains any errors that might have occurred.

    • getInternalCatalog

      ArchetypeCatalog getInternalCatalog()
      Gives the catalog of archetypes internal to the plugin.
      Returns:
      the catalog.

    • getLocalCatalog

      ArchetypeCatalog getLocalCatalog(org.eclipse.aether.RepositorySystemSession repositorySession)
      Gives the catalog of archetypes located in the given path. if path is a file, it used as is. if path is a directory, archetype-catalog.xml is appended to it.
      Parameters:
      repositorySession -
      Returns:
      the catalog.

    • getRemoteCatalog

      ArchetypeCatalog getRemoteCatalog(org.eclipse.aether.RepositorySystemSession repositorySession, List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories)
      Gives the catalog of archetypes located at https://repo.maven.apache.org/maven2/archetype-catalog.xml.
      Parameters:
      repositorySession -
      remoteRepositories -
      Returns:
      the catalog.

    • archiveArchetype

      @Deprecated File archiveArchetype(File archetypeDirectory, File outputDirectory, String finalName) throws org.apache.maven.artifact.DependencyResolutionRequiredException, IOException
      Deprecated.
      replaced by archetype plugin's JarMojo using maven-archiver component for Reproducible Builds
      Creates a jar file for an archetype.
      Parameters:
      archetypeDirectory -
      outputDirectory -
      finalName -
      Returns:
      The File to the generated jar
      Throws:
      org.apache.maven.artifact.DependencyResolutionRequiredException
      IOException

    • updateLocalCatalog

      File updateLocalCatalog(org.eclipse.aether.RepositorySystemSession repositorySystemSession, Archetype archetype)