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.shared.release.exec;
20
21 import java.io.File;
22
23 import org.apache.maven.shared.release.ReleaseResult;
24 import org.apache.maven.shared.release.env.ReleaseEnvironment;
25
26 /**
27 * Execute Maven. May be implemented as a forked instance, or embedded.
28 *
29 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
30 */
31 public interface MavenExecutor {
32 /**
33 * Execute goals using Maven.
34 *
35 * @param workingDirectory the directory to execute in
36 * @param goals the goals to run (space delimited)
37 * @param releaseEnvironment the environmental settings, maven-home, etc used for this release
38 * @param interactive whether to execute in interactive mode, or the default batch mode
39 * @param additionalArguments additional arguments to pass to the Maven command
40 * @param pomFileName the file name of the POM to execute on
41 * @param result holds all results of the execution
42 * @throws org.apache.maven.shared.release.exec.MavenExecutorException if an error occurred executing Maven
43 */
44 void executeGoals(
45 File workingDirectory,
46 String goals,
47 ReleaseEnvironment releaseEnvironment,
48 boolean interactive,
49 String additionalArguments,
50 String pomFileName,
51 ReleaseResult result)
52 throws MavenExecutorException;
53 }