1 package org.apache.maven.plugins.patchtracker.tracking;
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.plugin.logging.Log;
23
24 /**
25 * provide some services around a patch tracker.
26 * A patch tracker can be an issue tracker (jira) or a patch reviewer (reviewboar)
27 *
28 * @author Olivier Lamy
29 */
30 public interface PatchTracker
31 {
32
33 /**
34 * create a new entry in the patch tracker
35 *
36 * @param patchTrackerRequest
37 * @return
38 * @throws PatchTrackerException
39 */
40 PatchTrackerResult createPatch( PatchTrackerRequest patchTrackerRequest, Log log )
41 throws PatchTrackerException;
42
43 /**
44 * update a patch entry in the patch tracker
45 * <b>patchTrackerRequest.patchId is mandatory!</b>
46 *
47 * @param patchTrackerRequest
48 * @return
49 * @throws PatchTrackerException
50 */
51 PatchTrackerResult updatePatch( PatchTrackerRequest patchTrackerRequest, Log log )
52 throws PatchTrackerException;
53 }