1 package org.apache.maven.archetype.source;
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.Archetype;
23 import org.apache.maven.archetype.catalog.ArchetypeCatalog;
24 import org.apache.maven.project.ProjectBuildingRequest;
25
26 /**
27 * Sources we can get Archetypes from. This may be the local registry, a Wiki, or,
28 * a Maven Repository application. We might also want to get all the Archetypes based
29 * on some predetermined criteria and that could be anything given the source. A simple
30 * use-case might be to grab all Archetypes for a particular groupId, or Archetypes for
31 * webapps, or who knows what.
32 *
33 * @author Jason van Zyl
34 */
35 public interface ArchetypeDataSource
36 {
37 String ARCHETYPE_CATALOG_FILENAME = "archetype-catalog.xml";
38
39 ArchetypeCatalog getArchetypeCatalog( ProjectBuildingRequest buildingRequest )
40 throws ArchetypeDataSourceException;
41
42 void updateCatalog( ProjectBuildingRequest buildingRequest, Archetype archetype )
43 throws ArchetypeDataSourceException;
44 }