View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.archetype.source;
20  
21  import java.io.File;
22  import java.util.List;
23  
24  import org.apache.maven.archetype.catalog.Archetype;
25  import org.apache.maven.archetype.catalog.ArchetypeCatalog;
26  import org.eclipse.aether.RepositorySystemSession;
27  import org.eclipse.aether.repository.RemoteRepository;
28  
29  /**
30   * Sources we can get Archetypes from. This may be the local registry, a Wiki, or,
31   * a Maven Repository application. We might also want to get all the Archetypes based
32   * on some predetermined criteria and that could be anything given the source. A simple
33   * use-case might be to grab all Archetypes for a particular groupId, or Archetypes for
34   * webapps, or who knows what.
35   *
36   * @author Jason van Zyl
37   */
38  public interface ArchetypeDataSource {
39      String ARCHETYPE_CATALOG_FILENAME = "archetype-catalog.xml";
40  
41      ArchetypeCatalog getArchetypeCatalog(
42              RepositorySystemSession repositorySession, List<RemoteRepository> remoteRepositories)
43              throws ArchetypeDataSourceException;
44  
45      File updateCatalog(RepositorySystemSession repositorySession, Archetype archetype)
46              throws ArchetypeDataSourceException;
47  }