1 package org.apache.maven.shared.release;
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 /**
23 * Release management classes.
24 *
25 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
26 */
27 public interface ReleaseManager
28 {
29 /**
30 * Prepare a release.
31 *
32 * @param prepareRequest all prepare arguments
33 * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem performing the release
34 * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem performing the release
35 * @since 2.3
36 */
37 void prepare( ReleasePrepareRequest prepareRequest ) throws ReleaseExecutionException, ReleaseFailureException;
38
39 /**
40 * <p>prepareWithResult.</p>
41 *
42 * @param prepareRequest a {@link org.apache.maven.shared.release.ReleasePrepareRequest} object
43 * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
44 */
45 ReleaseResult prepareWithResult( ReleasePrepareRequest prepareRequest );
46
47 /**
48 * <p>performWithResult.</p>
49 *
50 * @param performRequest a {@link org.apache.maven.shared.release.ReleasePerformRequest} object
51 * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
52 */
53 ReleaseResult performWithResult( ReleasePerformRequest performRequest );
54
55 /**
56 * Perform a release
57 *
58 * @param performRequest all perform arguments
59 * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem performing the release
60 * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem performing the release
61 * @since 2.3
62 */
63 void perform( ReleasePerformRequest performRequest )
64 throws ReleaseExecutionException, ReleaseFailureException;
65
66 /**
67 * Clean a release.
68 *
69 * @param cleanRequest all clean arguments
70 * @throws org.apache.maven.shared.release.ReleaseFailureException if exception when releasing
71 * @since 2.3
72 */
73 void clean( ReleaseCleanRequest cleanRequest ) throws ReleaseFailureException;
74
75 /**
76 * Rollback changes made by the previous release
77 *
78 * @param rollbackRequest all rollback arguments
79 * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during release rollback
80 * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during release rollback
81 * @since 2.3
82 */
83 void rollback( ReleaseRollbackRequest rollbackRequest )
84 throws ReleaseExecutionException, ReleaseFailureException;
85
86 /**
87 * Branch a project
88 *
89 * @param branchRequest all branch arguments
90 * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during release branch
91 * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during release branch
92 * @since 2.3
93 */
94 void branch( ReleaseBranchRequest branchRequest ) throws ReleaseExecutionException, ReleaseFailureException;
95
96 /**
97 * Update version numbers for a project
98 *
99 * @param updateVersionsRequest all update versions arguments
100 * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during update versions
101 * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during update versions
102 * @since 2.3
103 */
104 void updateVersions( ReleaseUpdateVersionsRequest updateVersionsRequest )
105 throws ReleaseExecutionException, ReleaseFailureException;
106 }