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.ui.generation;
20  
21  import java.io.IOException;
22  
23  import org.apache.maven.archetype.ArchetypeGenerationRequest;
24  import org.apache.maven.archetype.exception.ArchetypeNotDefined;
25  import org.apache.maven.archetype.exception.ArchetypeSelectionFailure;
26  import org.apache.maven.archetype.exception.UnknownArchetype;
27  import org.apache.maven.archetype.exception.UnknownGroup;
28  import org.codehaus.plexus.components.interactivity.PrompterException;
29  
30  /**
31   * Selection component to organize steps to choose an archetype.
32   */
33  // TODO: We should need any remote repositories here, we should simply be doing selection, any remote catalogs
34  //      should be validating correctness, and if it so happens we get a crap entry then the generation mechanism
35  //      should take care of reporting the error. The selector should not be downloading anything.
36  public interface ArchetypeSelector {
37      String ROLE = ArchetypeSelector.class.getName();
38  
39      void selectArchetype(ArchetypeGenerationRequest request, Boolean interactiveMode, String catalogs)
40              throws ArchetypeNotDefined, UnknownArchetype, UnknownGroup, IOException, PrompterException,
41                      ArchetypeSelectionFailure;
42  }