Index (Apache Maven Executor 1.0.0 API)

A B C D E F G I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

argument(String) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
arguments() - Method in interface org.apache.maven.executor.ExecutorRequest: The immutable list of arguments to pass to the command.
arguments(String...) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
arguments(List<String>) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
artifactPath(ExecutorRequest.Builder, String, String) - Method in interface org.apache.maven.executor.ExecutorTool: Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given artifact in local repository.
artifactPath(ExecutorRequest.Builder, String, String) - Method in class org.apache.maven.executor.support.ToolboxExecutorTool
AUTO - Enum constant in enum org.apache.maven.executor.ExecutorHelper.Mode: Automatically decide.

B

build() - Method in class org.apache.maven.executor.ExecutorRequest.Builder

C

cache - Variable in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
cache - Variable in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
checkStartupState(DockerClient, String) - Method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor.MemoizingOneShotStartupCheckStrategy
close() - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
close() - Method in interface org.apache.maven.executor.Executor: Closes and disposes of this Executor instance, releasing any resources it may hold.
close() - Method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
close() - Method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
close() - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
close() - Method in class org.apache.maven.executor.support.ProcessBuilderExecutorSupport
closed - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
closed - Variable in class org.apache.maven.executor.support.ProcessBuilderExecutorSupport
command() - Method in interface org.apache.maven.executor.ExecutorRequest: The command to execute, ie "mvn".
command(String) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
Context(URLClassLoader, String, Object, Set<String>, ClassLoader, Map<String, Function<ExecutorRequest, ExecutorResult>>, Collection<Object>) - Constructor for class org.apache.maven.executor.embedded.EmbeddedMavenExecutor.Context
contextMap - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
createMavenBootClassLoader(Path, List<URL>) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
createSimpleProject(Path) - Static method in class org.apache.maven.executor.test.TestProjects
cwd() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns the current working directory for the Maven execution.
cwd(Path) - Method in class org.apache.maven.executor.ExecutorRequest.Builder

D

detectUid(Path) - Method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
detectUid(Path) - Method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
discoverInstallationDirectory() - Static method in interface org.apache.maven.executor.ExecutorRequest
discoverUserHomeDirectory() - Static method in interface org.apache.maven.executor.ExecutorRequest
disposeRuntimeCreatedRealms(EmbeddedMavenExecutor.Context) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor: Unloads dynamically loaded things, like extensions created realms.
DockerExeExecutor - Class in org.apache.maven.executor.providers.dockerexe: Executor that spawns a process with docker CLI to execute request.
DockerExeExecutor(String, String) - Constructor for class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
doClose() - Method in class org.apache.maven.executor.support.ProcessBuilderExecutorSupport
doClose(EmbeddedMavenExecutor.Context) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
doCreate(Path, ExecutorRequest) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
doExecute(ExecutorRequest) - Method in class org.apache.maven.executor.forked.ForkedMavenExecutor
doExecuteProcess(ExecutorRequest, ProcessBuilder) - Method in class org.apache.maven.executor.support.ProcessBuilderExecutorSupport
dump(ExecutorRequest.Builder) - Method in interface org.apache.maven.executor.ExecutorTool: Performs a diagnostic dump of the environment.
dump(ExecutorRequest.Builder) - Method in class org.apache.maven.executor.support.ToolboxExecutorTool

E

EMBEDDED - Enum constant in enum org.apache.maven.executor.ExecutorHelper.Mode: Forces embedded execution.
EmbeddedMavenExecutor - Class in org.apache.maven.executor.embedded: Embedded executor implementation, that invokes Maven from installation directory within this same JVM but in isolated classloader.
EmbeddedMavenExecutor(Path) - Constructor for class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
EmbeddedMavenExecutor(Path, boolean) - Constructor for class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
EmbeddedMavenExecutor.Context - Class in org.apache.maven.executor.embedded: Context holds things loaded up from given Maven Installation Directory.
environmentVariable(String, String) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
environmentVariables() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns the map of environment variables to set before executing process.
environmentVariables(Map<String, String>) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
execute(ExecutorHelper.Mode, ExecutorRequest) - Method in interface org.apache.maven.executor.ExecutorHelper: Executes the request with passed in mode executor.
execute(ExecutorHelper.Mode, ExecutorRequest) - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
execute(ExecutorRequest) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
execute(ExecutorRequest) - Method in interface org.apache.maven.executor.Executor: Invokes the tool application using the provided ExecutorRequest.
execute(ExecutorRequest) - Method in interface org.apache.maven.executor.ExecutorHelper: Executes the request with preferred mode executor.
execute(ExecutorRequest) - Method in class org.apache.maven.executor.forked.ForkedMavenExecutor
execute(ExecutorRequest) - Method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
execute(ExecutorRequest) - Method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor: Note: Testcontainers uses Lombok @Sneakythrows.
executionTimeout() - Method in interface org.apache.maven.executor.ExecutorRequest: The optional execution time limit.
executionTimeout(Duration) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
Executor - Interface in org.apache.maven.executor: Defines the contract for a component responsible for executing a Maven tool using the information provided in an ExecutorRequest.
ExecutorException - Exception Class in org.apache.maven.executor: Represents an exception that occurs during the execution of a Maven build or command.
ExecutorException(String) - Constructor for exception class org.apache.maven.executor.ExecutorException: Constructs a new InvokerException with the specified detail message.
ExecutorException(String, Throwable) - Constructor for exception class org.apache.maven.executor.ExecutorException: Constructs a new InvokerException with the specified detail message and cause.
ExecutorException(Throwable) - Constructor for exception class org.apache.maven.executor.ExecutorException: Constructs a new InvokerException with the specified cause.
ExecutorHelper - Interface in org.apache.maven.executor: Helper class for routing Maven execution based on preferences and/or issued execution requests.
ExecutorHelper.Mode - Enum in org.apache.maven.executor: The modes of execution.
ExecutorHelperImpl - Class in org.apache.maven.executor.support: Simple router to executors, and delegate to executor tool.
ExecutorHelperImpl(ExecutorHelper.Mode, EmbeddedMavenExecutor, ForkedMavenExecutor, boolean) - Constructor for class org.apache.maven.executor.support.ExecutorHelperImpl
ExecutorRequest - Interface in org.apache.maven.executor: Represents a request to execute Maven with command-line arguments.
ExecutorRequest.Builder - Class in org.apache.maven.executor
ExecutorResult - Interface in org.apache.maven.executor: Represents an execution result.
ExecutorTool - Interface in org.apache.maven.executor: A tool implementing some common Maven operations.
exitCode() - Method in interface org.apache.maven.executor.ExecutorResult: The exit code, if available (ie running the tool happened in a way it did produce exit code).
exitCode() - Method in class org.apache.maven.executor.support.SimpleExecutionResult

F

forExecutors(ExecutorHelper.Mode, EmbeddedMavenExecutor, ForkedMavenExecutor) - Static method in interface org.apache.maven.executor.ExecutorHelper: Creates ExecutorHelper instance with provided default mode and provided executors.
FORKED - Enum constant in enum org.apache.maven.executor.ExecutorHelper.Mode: Forces forked execution.
ForkedMavenExecutor - Class in org.apache.maven.executor.forked: Forked executor implementation, that spawns a subprocess with Maven from the installation directory.
ForkedMavenExecutor(Path) - Constructor for class org.apache.maven.executor.forked.ForkedMavenExecutor
ForkedMavenExecutor(Path, boolean) - Constructor for class org.apache.maven.executor.forked.ForkedMavenExecutor
forMavenInstallation(Path, ExecutorHelper.Mode) - Static method in interface org.apache.maven.executor.ExecutorHelper: Creates ExecutorHelper along with needed executors using provided installation directory.

G

getCanonicalPath(Path) - Static method in interface org.apache.maven.executor.ExecutorRequest
getDefaultMode() - Method in interface org.apache.maven.executor.ExecutorHelper: Returns the preferred mode of this helper.
getDefaultMode() - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
getExecutor(ExecutorHelper.Mode, ExecutorRequest) - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
getExecutorByRequest(ExecutorRequest) - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
getMavenVersion(Class<?>) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
getRequest() - Method in interface org.apache.maven.executor.ExecutorResult: The ExecutorRequest this result is for.
getRequest() - Method in class org.apache.maven.executor.support.SimpleExecutionResult
grabOutputAsString() - Method in interface org.apache.maven.executor.ExecutorRequest: Whether execution outputs (STDOUT and STDERR) should be captured as plain String.
grabOutputAsString(boolean) - Method in class org.apache.maven.executor.ExecutorRequest.Builder

I

imageName - Variable in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
imageName - Variable in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
imageTag - Variable in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
imageTag - Variable in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
installationDirectory - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
installationDirectory - Variable in class org.apache.maven.executor.forked.ForkedMavenExecutor
IOTools - Class in org.apache.maven.executor.support: Support class IO.
IS_WINDOWS - Static variable in interface org.apache.maven.executor.Executor

J

jvmArgument(String) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
jvmArguments() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns the list of extra JVM arguments to be passed to the forked process.
jvmArguments(List<String>) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
jvmSystemProperties() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns the map of Java System Properties to set before executing process.
jvmSystemProperties(Map<String, String>) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
jvmSystemProperty(String, String) - Method in class org.apache.maven.executor.ExecutorRequest.Builder

L

localRepository(ExecutorRequest.Builder) - Method in interface org.apache.maven.executor.ExecutorTool: Returns the location of local repository, as detected by Maven.
localRepository(ExecutorRequest.Builder) - Method in class org.apache.maven.executor.support.ToolboxExecutorTool

M

mavenBuilder() - Static method in interface org.apache.maven.executor.ExecutorRequest: Returns new builder pre-set to run Maven.
MavenToolProvider - Class in org.apache.maven.executor.tool: See Java 9 class, this is placeholder.
MavenToolProvider() - Constructor for class org.apache.maven.executor.tool.MavenToolProvider
mavenVersion() - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
mavenVersion() - Method in interface org.apache.maven.executor.Executor: Returns the Maven version that this executor points at (would use).
mavenVersion() - Method in class org.apache.maven.executor.forked.ForkedMavenExecutor
mavenVersion() - Method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor
mavenVersion() - Method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
mavenVersion() - Method in class org.apache.maven.executor.support.ExecutorHelperImpl
MemoizingOneShotStartupCheckStrategy() - Constructor for class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor.MemoizingOneShotStartupCheckStrategy
metadataPath(ExecutorRequest.Builder, String, String) - Method in interface org.apache.maven.executor.ExecutorTool: Returns relative (to ExecutorTool.localRepository(ExecutorRequest.Builder)) path of given metadata in local repository.
metadataPath(ExecutorRequest.Builder, String, String) - Method in class org.apache.maven.executor.support.ToolboxExecutorTool
MVN - Static variable in interface org.apache.maven.executor.ExecutorRequest: The Maven command.
MVN4_MAIN_CLASSES - Static variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor: Maven4 supports multiple commands from same installation directory.

N

name() - Method in class org.apache.maven.executor.tool.MavenToolProvider
nullInputStream() - Static method in class org.apache.maven.executor.support.IOTools: Copy from Java 9+
nullOutputStream() - Static method in class org.apache.maven.executor.support.IOTools: Copy from Java 9+

O

org.apache.maven.executor - package org.apache.maven.executor: The Maven Executor main package.
org.apache.maven.executor.embedded - package org.apache.maven.executor.embedded
org.apache.maven.executor.forked - package org.apache.maven.executor.forked
org.apache.maven.executor.providers.dockerexe - package org.apache.maven.executor.providers.dockerexe
org.apache.maven.executor.providers.testcontainers - package org.apache.maven.executor.providers.testcontainers
org.apache.maven.executor.support - package org.apache.maven.executor.support
org.apache.maven.executor.test - package org.apache.maven.executor.test
org.apache.maven.executor.tool - package org.apache.maven.executor.tool
originalClassLoader - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
originalProperties - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
originalStderr - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
originalStdin - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
originalStdout - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor

P

prepareProperties(ExecutorRequest) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
ProcessBuilderExecutorSupport - Class in org.apache.maven.executor.support: Support class for executor implementations using ProcessBuilder.
ProcessBuilderExecutorSupport() - Constructor for class org.apache.maven.executor.support.ProcessBuilderExecutorSupport
pump(Process, InputStream, OutputStream, OutputStream) - Method in class org.apache.maven.executor.support.ProcessBuilderExecutorSupport

R

run(PrintWriter, PrintWriter, String...) - Method in class org.apache.maven.executor.tool.MavenToolProvider

S

SimpleExecutionResult - Class in org.apache.maven.executor.support: Simple execution result.
SimpleExecutionResult(ExecutorRequest, boolean, Integer, String, String) - Constructor for class org.apache.maven.executor.support.SimpleExecutionResult: Constructor.
skipMavenRc() - Method in interface org.apache.maven.executor.ExecutorRequest: Indicate if ~/.mavenrc should be skipped during execution.
skipMavenRc(boolean) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
stdErr() - Method in interface org.apache.maven.executor.ExecutorRequest: Optional consumer for STD err of the Maven.
stdErr(OutputStream) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
stdErrString() - Method in interface org.apache.maven.executor.ExecutorResult: If ExecutorRequest.grabOutputAsString() was true, then the String containing STDERR of tool.
stdErrString() - Method in class org.apache.maven.executor.support.SimpleExecutionResult
stdIn() - Method in interface org.apache.maven.executor.ExecutorRequest: Optional provider for STD in of the Maven.
stdIn(InputStream) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
stdOut() - Method in interface org.apache.maven.executor.ExecutorRequest: Optional consumer for STD out of the Maven.
stdOut(OutputStream) - Method in class org.apache.maven.executor.ExecutorRequest.Builder
stdOutString() - Method in interface org.apache.maven.executor.ExecutorResult: If ExecutorRequest.grabOutputAsString() was true, then the String containing STDOUT of tool.
stdOutString() - Method in class org.apache.maven.executor.support.SimpleExecutionResult
success() - Method in interface org.apache.maven.executor.ExecutorResult: The outcome of execution.
success() - Method in class org.apache.maven.executor.support.SimpleExecutionResult

T

TestContainersExecutor - Class in org.apache.maven.executor.providers.testcontainers: Executor that uses Testcontainers to execute request.
TestContainersExecutor(String, String) - Constructor for class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor
TestContainersExecutor.MemoizingOneShotStartupCheckStrategy - Class in org.apache.maven.executor.providers.testcontainers
TestProjects - Class in org.apache.maven.executor.test
toBuilder() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns ExecutorRequest.Builder created from this instance.
ToolboxExecutorTool - Class in org.apache.maven.executor.support: ExecutorTool implementation based on Maveniverse Toolbox.
ToolboxExecutorTool(Executor) - Constructor for class org.apache.maven.executor.support.ToolboxExecutorTool: Deprecated.
Better specify required version yourself. This one is "cemented" to 0.15.8
ToolboxExecutorTool(Executor, String) - Constructor for class org.apache.maven.executor.support.ToolboxExecutorTool
transferTo(InputStream, OutputStream) - Static method in class org.apache.maven.executor.support.IOTools: Copy from Java 9+

U

UNKNOWN_VERSION - Static variable in interface org.apache.maven.executor.Executor: Maven version string returned when the actual version of Maven cannot be determined.
useMavenArgsEnv - Variable in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
useMavenArgsEnv - Variable in class org.apache.maven.executor.forked.ForkedMavenExecutor
userHomeDirectory() - Method in interface org.apache.maven.executor.ExecutorRequest: Returns the user's home directory.
userHomeDirectory(Path) - Method in class org.apache.maven.executor.ExecutorRequest.Builder

V

validate(ExecutorRequest) - Method in class org.apache.maven.executor.embedded.EmbeddedMavenExecutor
validate(ExecutorRequest) - Method in class org.apache.maven.executor.forked.ForkedMavenExecutor
valueOf(String) - Static method in enum org.apache.maven.executor.ExecutorHelper.Mode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.maven.executor.ExecutorHelper.Mode: Returns an array containing the constants of this enum type, in the order they are declared.

W

withImage(String, String) - Static method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor: Method to create executor that will use given Docker image with optionally provided tag.
withImage(String, String) - Static method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor: Method to create executor that will use given Docker image with optionally provided tag.
withMavenImageVersion(String) - Static method in class org.apache.maven.executor.providers.dockerexe.DockerExeExecutor: Method to create executor that will use Maven Docker image with given tag (Maven version).
withMavenImageVersion(String) - Static method in class org.apache.maven.executor.providers.testcontainers.TestContainersExecutor: Method to create executor that will use Maven Docker image with given tag (Maven version).

A B C D E F G I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form