1 package org.apache.maven.shared.invoker;
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.io.File;
23 import java.io.InputStream;
24
25 /**
26 * Provides a facade to invoke Maven.
27 *
28 * @version $Id: Invoker.java 1395172 2012-10-06 21:15:33Z rfscholte $
29 */
30 public interface Invoker
31 {
32
33 /**
34 * The role name used to register implementations of this interface within Plexus.
35 */
36 String ROLE = Invoker.class.getName();
37
38 /**
39 * @deprecated Query this property by yourself, this has nothing to do with invoking Maven and as such does not
40 * belong into this API!
41 */
42 String userHome = System.getProperty( "user.home" );
43
44 /**
45 * Executes Maven using the parameters specified by the given invocation request. Parameters not specified by the
46 * invocation request will be derived from the state of this invoker instance. In case both the invoker instance and
47 * the invocation request provide a value for a particular option, the value from the invocation request dominates.
48 *
49 * @param request The invocation request to execute, must not be <code>null</code>.
50 * @return The result of the Maven invocation, never <code>null</code>.
51 * @throws MavenInvocationException
52 */
53 InvocationResult execute( InvocationRequest request )
54 throws MavenInvocationException;
55
56 /**
57 * Gets the path to the base directory of the local repository to use for the Maven invocation.
58 *
59 * @return The path to the base directory of the local repository or <code>null</code> to use the location from
60 * the <code>settings.xml</code>.
61 */
62 File getLocalRepositoryDirectory();
63
64 /**
65 * Gets the working directory for the Maven invocation.
66 *
67 * @return The working directory for the Maven invocation or <code>null</code> if the working directory is derived
68 * from the base directory of the processed POM.
69 */
70 File getWorkingDirectory();
71
72 /**
73 * Gets the logger used by this invoker to output diagnostic messages.
74 *
75 * @return The logger used by this invoker to output diagnostic messages, never <code>null</code>.
76 */
77 InvokerLogger getLogger();
78
79 /**
80 * Gets the path to the base directory of the Maven installation used to invoke Maven.
81 *
82 * @return The path to the base directory of the Maven installation or <code>null</code> if using the default
83 * Maven installation.
84 */
85 File getMavenHome();
86
87 /**
88 * Sets the path to the base directory of the Maven installation used to invoke Maven. This parameter may be left
89 * unspecified to use the default Maven installation which will be discovered by evaluating the system property
90 * <code>maven.home</code> and the environment variable <code>M2_HOME</code>.
91 *
92 * @param mavenHome The path to the base directory of the Maven installation, may be <code>null</code> to use the
93 * default Maven installation.
94 * @return This invoker instance.
95 */
96 Invoker setMavenHome( File mavenHome );
97
98 /**
99 * Get the customized File of the Maven executable.
100 *
101 * @return the custom Maven executable, otherwise {@code null}
102 */
103 File getMavenExecutable();
104
105 /**
106 * {@code mavenExecutable} can either be a file relative to ${maven.home}/bin/ or an absolute file.
107 *
108 * @param mavenExecutable the executable
109 * @return This invoker instance
110 */
111 Invoker setMavenExecutable( File mavenExecutable );
112
113 /**
114 * Sets the path to the base directory of the local repository to use for the Maven invocation.
115 *
116 * @param localRepositoryDirectory The path to the base directory of the local repository or <code>null</code> to
117 * use the location from the <code>settings.xml</code>.
118 * @return This invoker instance.
119 */
120 Invoker setLocalRepositoryDirectory( File localRepositoryDirectory );
121
122 /**
123 * Sets the logger used by this invoker to output diagnostic messages.
124 *
125 * @param logger The logger used by this invoker to output diagnostic messages, may be <code>null</code> to use a
126 * default logger.
127 * @return This invoker instance.
128 */
129 Invoker setLogger( InvokerLogger logger );
130
131 /**
132 * Sets the working directory for the Maven invocation.
133 *
134 * @param workingDirectory The working directory for the Maven invocation, may be <code>null</code> to derive the
135 * working directory from the base directory of the processed POM.
136 * @return This invoker instance.
137 */
138 Invoker setWorkingDirectory( File workingDirectory );
139
140 /**
141 * Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when
142 * invoking Maven in interactive mode.
143 *
144 * @param inputStream The input stream used to provide input for the invoked Maven build, may be <code>null</code>
145 * if not required.
146 * @return This invoker instance.
147 */
148 Invoker setInputStream( InputStream inputStream );
149
150 /**
151 * Sets the handler used to capture the standard output from the Maven build.
152 *
153 * @param outputHandler The output handler, may be <code>null</code> if the output is not of interest.
154 * @return This invoker instance.
155 */
156 Invoker setOutputHandler( InvocationOutputHandler outputHandler );
157
158 /**
159 * Sets the handler used to capture the error output from the Maven build.
160 *
161 * @param errorHandler The error handler, may be <code>null</code> if the output is not of interest.
162 * @return This invoker instance.
163 */
164 Invoker setErrorHandler( InvocationOutputHandler errorHandler );
165 }