View Javadoc
1   package org.apache.maven.archetype.mojos;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.archetype.catalog.ArchetypeCatalog;
23  import org.apache.maven.archetype.repositorycrawler.RepositoryCrawler;
24  import org.apache.maven.plugin.AbstractMojo;
25  import org.apache.maven.plugin.MojoExecutionException;
26  import org.apache.maven.plugin.MojoFailureException;
27  import org.apache.maven.plugins.annotations.Component;
28  import org.apache.maven.plugins.annotations.Mojo;
29  import org.apache.maven.plugins.annotations.Parameter;
30  
31  import java.io.File;
32  
33  /**
34   * Crawl a Maven repository (filesystem, not HTTP) and creates a catalog file.
35   *
36   * @author rafale
37   */
38  @Mojo( name = "crawl", requiresProject = false )
39  public class CrawlRepositoryMojo
40      extends AbstractMojo
41  {
42      /**
43       * The archetype's catalog to update.
44       */
45      @Parameter( property = "catalog" )
46      private File catalogFile;
47  
48      @Component
49      private RepositoryCrawler crawler;
50  
51      /**
52       * The repository to crawl.
53       */
54      @Parameter( property = "repository", defaultValue = "${settings.localRepository}" )
55      private File repository;
56  
57      public void execute()
58          throws MojoExecutionException, MojoFailureException
59      {
60          getLog().debug( "repository " + repository + ", catalogFile " + catalogFile );
61  
62          if ( repository == null )
63          {
64              throw new MojoFailureException( "The repository is not defined. Use -Drepository=/path/to/repository" );
65          }
66  
67          ArchetypeCatalog catalog = crawler.crawl( repository );
68  
69          if ( catalogFile == null )
70          {
71              catalogFile = new File( repository, "archetype-catalog.xml" );
72          }
73  
74          crawler.writeCatalog( catalog, catalogFile );
75      }
76  }