1 package org.apache.maven.plugin.issues;
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 java.util.Map;
23
24 import org.apache.maven.plugin.MojoExecutionException;
25 import org.apache.maven.plugin.changes.IssueType;
26
27 /**
28 * An interface for issue management systems.
29 * <p/>
30 * The plan is to enhance this interface to allow communication with different issue management systems in a consistent
31 * way.
32 */
33 public interface IssueManagementSystem
34 {
35
36 /**
37 * Get a mapping of issue types used in this issue management system to the ones used in a changes.xml file.
38 *
39 * @return The map from keys used in poms and other config files to issue types.
40 */
41 public abstract Map<String, IssueType> getIssueTypeMap();
42
43 /**
44 * Get the name of the issue management system.
45 *
46 * @return The name of the IMS.
47 */
48 public abstract String getName();
49
50 /**
51 * Configure this issue management system.
52 *
53 * @param issueTypes The mapping of issue types used in this issue management system to the ones used in a changes.xml file
54 * @throws MojoExecutionException If the configuration fails
55 */
56 public abstract void applyConfiguration( Map<String, String> issueTypes )
57 throws MojoExecutionException;
58
59 }