org.apache.maven.shared.invoker.Invoker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-invoker Show documentation
A component to programmatically invoke Maven.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.shared.invoker;

import java.io.File;
import java.io.InputStream;

/**
 * Provides a facade to invoke Maven.
 *
 */
public interface Invoker {

    /**
     * The role name used to register implementations of this interface within Plexus.
     */
    String ROLE = Invoker.class.getName();

    /**
     * Executes Maven using the parameters specified by the given invocation request. Parameters not specified by the
     * invocation request will be derived from the state of this invoker instance. In case both the invoker instance and
     * the invocation request provide a value for a particular option, the value from the invocation request dominates.
     *
     * @param request The invocation request to execute, must not be null.
     * @return The result of the Maven invocation, never null.
     * @throws MavenInvocationException if cannot configure correctly execution parameters
     */
    InvocationResult execute(InvocationRequest request) throws MavenInvocationException;

    /**
     * Gets the path to the base directory of the local repository to use for the Maven invocation.
     *
     * @return The path to the base directory of the local repository or null to use the location from
     *         the settings.xml.
     */
    File getLocalRepositoryDirectory();

    /**
     * Gets the working directory for the Maven invocation.
     *
     * @return The working directory for the Maven invocation or null if the working directory is derived
     *         from the base directory of the processed POM.
     */
    File getWorkingDirectory();

    /**
     * Gets the logger used by this invoker to output diagnostic messages.
     *
     * @return The logger used by this invoker to output diagnostic messages, never null.
     */
    InvokerLogger getLogger();

    /**
     * Gets the path to the base directory of the Maven installation used to invoke Maven.
     *
     * @return The path to the base directory of the Maven installation or null if using the default
     *         Maven installation.
     */
    File getMavenHome();

    /**
     * Sets the path to the base directory of the Maven installation used to invoke Maven. This parameter may be left
     * unspecified to use the default Maven installation which will be discovered by evaluating the system property
     * maven.home.
     *
     * @param mavenHome The path to the base directory of the Maven installation, may be null to use the
     *            default Maven installation.
     * @return This invoker instance.
     */
    Invoker setMavenHome(File mavenHome);

    /**
     * Get the customized File of the Maven executable.
     *
     * @return the custom Maven executable, otherwise {@code null}
     */
    File getMavenExecutable();

    /**
     * {@code mavenExecutable} can either be a file relative to ${maven.home}/bin/ or an absolute file.
     *
     * @param mavenExecutable the executable
     * @return This invoker instance
     */
    Invoker setMavenExecutable(File mavenExecutable);

    /**
     * Sets the path to the base directory of the local repository to use for the Maven invocation.
     *
     * @param localRepositoryDirectory The path to the base directory of the local repository or null to
     *            use the location from the settings.xml.
     * @return This invoker instance.
     */
    Invoker setLocalRepositoryDirectory(File localRepositoryDirectory);

    /**
     * Sets the logger used by this invoker to output diagnostic messages.
     *
     * @param logger The logger used by this invoker to output diagnostic messages, may be null to use a
     *            default logger.
     * @return This invoker instance.
     */
    Invoker setLogger(InvokerLogger logger);

    /**
     * Sets the working directory for the Maven invocation.
     *
     * @param workingDirectory The working directory for the Maven invocation, may be null to derive the
     *            working directory from the base directory of the processed POM.
     * @return This invoker instance.
     *
     * @deprecated Please use {@link InvocationRequest#setBaseDirectory(File)}
     */
    @Deprecated
    Invoker setWorkingDirectory(File workingDirectory);

    /**
     * Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when
     * invoking Maven in interactive mode.
     *
     * @param inputStream The input stream used to provide input for the invoked Maven build, may be null
     *            if not required.
     * @return This invoker instance.
     *
     * @deprecated Please use {@link InvocationRequest#setInputStream(InputStream)}
     */
    @Deprecated
    Invoker setInputStream(InputStream inputStream);

    /**
     * Sets the handler used to capture the standard output from the Maven build.
     *
     * @param outputHandler The output handler, may be null if the output is not of interest.
     * @return This invoker instance.
     *
     * @deprecated Please use {@link InvocationRequest#setOutputHandler(InvocationOutputHandler)}
     */
    @Deprecated
    Invoker setOutputHandler(InvocationOutputHandler outputHandler);

    /**
     * Sets the handler used to capture the error output from the Maven build.
     *
     * @param errorHandler The error handler, may be null if the output is not of interest.
     * @return This invoker instance.
     *
     * @deprecated Pleas use {@link InvocationRequest#setErrorHandler(InvocationOutputHandler)}
     */
    @Deprecated
    Invoker setErrorHandler(InvocationOutputHandler errorHandler);
}