AbstractJvmModelExecTask (Grolifant Core API)

org.ysb33r.grolifant5.api.core.runnable.AbstractJvmModelExecTask

All Implemented Interfaces and Traits:: ForkedJvmExecutable, JvmExecutionModel

public abstract class AbstractJvmModelExecTask<T extends AbstractJvmExecSpec, P extends SerializableWorkerAppParameters>
extends GrolifantDefaultTask
implements ForkedJvmExecutable, JvmExecutionModel

Configures a task that will run an execution in a forked JVM.

Authors:: Schalk W. Cronj̧é

Since:: 2.0

Constructor Summary

Constructors
Constructor and description
`protected AbstractJvmModelExecTask (WorkerExecutor we)` Base class for executing tasks on the JVM.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected abstract org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P>`	`createExecutorFactory()` Create a worker app executor factory.
	`protected abstract WorkerAppParameterFactory<P>`	`createParameterFactory()` Create a worker app parameter factory.
	`public T`	`entrypoint(Action<JvmEntryPoint> configurator)` Configures the entrypoint for the JVM executable.
	`public T`	`entrypoint(groovy.lang.Closure<?> configurator)` Configures the entrypoint for the JVM executable
	`protected void`	`exec()`
	`public JvmEntryPoint`	`getEntrypoint()` Get direct access to the JvmEntryPoint instance.
	`public JavaForkOptionsWithEnvProvider`	`getJvm()` Direct access to the JavaForkOptionsWithEnvProvider instance.
	`protected T`	`getJvmExecSpec()`
	`public ProcessExecutionSpec`	`getProcess()` Get direct access to the ProcessExecutionSpec instance.
	`public CmdlineArgumentSpec`	`getRunnerSpec()` Get direct access to the CmdlineArgumentSpec instance.
	`public T`	`jvm(Action<JavaForkOptionsWithEnvProvider> configurator)` Configures a JVM that will be forked.
	`public T`	`jvm(groovy.lang.Closure<?> configurator)` Configures a JVM that will be forked.
	`protected void`	`preventExecutionMode(ExecutionMode mode, String reason)` Prevents a specific execution mode from being set.
	`public T`	`process(Action<ProcessExecutionSpec> configurator)` Configures the stream redirection and exit code checks.
	`public T`	`process(groovy.lang.Closure<?> configurator)` Configures the stream redirections and exit checks.
	`protected void`	`processOutput(ExecOutput output)` Process the output from an ExecOutput.
	`public T`	`runnerSpec(Action<CmdlineArgumentSpec> configurator)` Configures the arguments.
	`public T`	`runnerSpec(groovy.lang.Closure<?> configurator)` Configures the arguments.
	`public void`	`setAwaitMode(Boolean mode)` Set whether other tasks in this project should be blocked until this task's worker queue completed.
	`protected void`	`setExecSpec(T execSpec)`
	`public void`	`setExecutionMode(ExecutionMode em)` Sets the execution mode.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GrolifantDefaultTask`	`execTools, fsOperations, getGrolifantSecurePropertyService, jvmTools, problemReporter, projectTools, providerTools, stringTools`

- Constructor Detail
  - protected AbstractJvmModelExecTask(@javax.annotation.Nullable WorkerExecutor we)
    
    Base class for executing tasks on the JVM.
    Parameters:
    we - Can be null, in which case workers will not be supported
- Method Detail
  - protected abstract org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P> createExecutorFactory()
    
    Create a worker app executor factory.
    Returns:
    Instance of an execution factory.
  - protected abstract WorkerAppParameterFactory<P> createParameterFactory()
    
    Create a worker app parameter factory.
    Returns:
    Instance of a parameter factory.
  - @Override public T entrypoint(Action<JvmEntryPoint> configurator)
    
    Configures the entrypoint for the JVM executable.
    This includes the classpath, modularity and main class.
    
    Parameters:
    configurator - An action to configure the entrypoint
    Returns:
    The configured executable.
  - @Override public T entrypoint(@groovy.lang.DelegatesTo(JvmEntryPoint.class) groovy.lang.Closure<?> configurator)
    
    Configures the entrypoint for the JVM executable
    Parameters:
    configurator - A closure to configure the entrypoint
    Returns:
    The configured executable.
  - @TaskAction protected void exec()
  - @Override public JvmEntryPoint getEntrypoint()
    
    Get direct access to the JvmEntryPoint instance.
    Returns:
    Something that implements JvmEntryPoint.
    Since:
    5.5
  - @Override public JavaForkOptionsWithEnvProvider getJvm()
    
    Direct access to the JavaForkOptionsWithEnvProvider instance.
    Returns:
    The fork options.
    Since:
    5.5
  - @Nested protected T getJvmExecSpec()
  - @Override public ProcessExecutionSpec getProcess()
    
    Get direct access to the ProcessExecutionSpec instance.
    Returns:
    Something that implements ProcessExecutionSpec.
    Since:
    5.5
  - @Override public CmdlineArgumentSpec getRunnerSpec()
    
    Get direct access to the CmdlineArgumentSpec instance.
    Returns:
    Something that implements CmdlineArgumentSpec.
    Since:
    5.5
  - @Override public T jvm(Action<JavaForkOptionsWithEnvProvider> configurator)
    
    Configures a JVM that will be forked.
    Parameters:
    configurator - An action to configure the JVM's fork options.
    Returns:
    The configured executable
  - @Override public T jvm(@groovy.lang.DelegatesTo(JavaForkOptionsWithEnvProvider.class) groovy.lang.Closure<?> configurator)
    
    Configures a JVM that will be forked.
    Parameters:
    configurator - A closure to configure the JVM's fork options.
    Returns:
    The configured executable
  - protected void preventExecutionMode(ExecutionMode mode, String reason)
    
    Prevents a specific execution mode from being set.
    Parameters:
    mode - Illegal execution mode
    reason - Reason why execution mode cannot be used.
  - @Override public T process(Action<ProcessExecutionSpec> configurator)
    
    Configures the stream redirection and exit code checks.
    This includes the inputs and output streams as well as the exit value.
    
    Parameters:
    configurator - An action to configure the execution.
    Returns:
    The configured executable.
  - @Override public T process(@groovy.lang.DelegatesTo(ProcessExecutionSpec.class) groovy.lang.Closure<?> configurator)
    
    Configures the stream redirections and exit checks.
    Parameters:
    configurator - A closure to configure the execution.
    Returns:
    The configured executable.
  - protected void processOutput(ExecOutput output)
    
    Process the output from an ExecOutput.
    Parameters:
    output - Output to process.
    Since:
    5.0
  - @Override public T runnerSpec(Action<CmdlineArgumentSpec> configurator)
    
    Configures the arguments.
    Parameters:
    configurator - An action to configure the arguments.
    Returns:
    The configured executable
  - @Override public T runnerSpec(@groovy.lang.DelegatesTo(CmdlineArgumentSpec.class) groovy.lang.Closure<?> configurator)
    
    Configures the arguments.
    Parameters:
    configurator - A closure to configure the arguments.
    Returns:
    The configured executable
  - @Override public void setAwaitMode(Boolean mode)
    
    Set whether other tasks in this project should be blocked until this task's worker queue completed.
    Ignored if executionMode == JAVA_EXEC.
    Parameters:
    mode - true is blocking is required.
  - protected void setExecSpec(T execSpec)
  - @Override public void setExecutionMode(ExecutionMode em)
    
    Sets the execution mode.
    This allows for JVM tasks to be executed either on a worker queue inside the JVM using an isolated classpath, outside the JVM in a separate process, OR using a classic javaexec.
    If nothing is set, the default is ExecutionMode#JAVA_EXEC#JAVA_EXEC.
    Parameters:
    em - Execution mode.
    Throws:
    UnsupportedConfigurationException is mode is illegal within context.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class AbstractJvmModelExecTask<T extends AbstractJvmExecSpec, P extends SerializableWorkerAppParameters>

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected AbstractJvmModelExecTask(@javax.annotation.Nullable WorkerExecutor we)

Method Detail

protected abstract org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P> createExecutorFactory()

protected abstract WorkerAppParameterFactory<P> createParameterFactory()

@Override public T entrypoint(Action<JvmEntryPoint> configurator)

@Override public T entrypoint(@groovy.lang.DelegatesTo(JvmEntryPoint.class) groovy.lang.Closure<?> configurator)

@TaskAction protected void exec()

@Override public JvmEntryPoint getEntrypoint()

@Override public JavaForkOptionsWithEnvProvider getJvm()

@Nested protected T getJvmExecSpec()

@Override public ProcessExecutionSpec getProcess()

@Override public CmdlineArgumentSpec getRunnerSpec()

@Override public T jvm(Action<JavaForkOptionsWithEnvProvider> configurator)

@Override public T jvm(@groovy.lang.DelegatesTo(JavaForkOptionsWithEnvProvider.class) groovy.lang.Closure<?> configurator)

protected void preventExecutionMode(ExecutionMode mode, String reason)

@Override public T process(Action<ProcessExecutionSpec> configurator)

@Override public T process(@groovy.lang.DelegatesTo(ProcessExecutionSpec.class) groovy.lang.Closure<?> configurator)

protected void processOutput(ExecOutput output)

@Override public T runnerSpec(Action<CmdlineArgumentSpec> configurator)

@Override public T runnerSpec(@groovy.lang.DelegatesTo(CmdlineArgumentSpec.class) groovy.lang.Closure<?> configurator)

@Override public void setAwaitMode(Boolean mode)

protected void setExecSpec(T execSpec)

@Override public void setExecutionMode(ExecutionMode em)