Package org.jenkinsci.plugins.workflow.steps

Class BodyInvoker

java.lang.Object

org.jenkinsci.plugins.workflow.steps.BodyInvoker

public abstract class BodyInvoker
extends Object

Builder pattern for controlling how to execute a body block of a Step.

Author:

Kohsuke Kawaguchi

See Also:

StepContext.newBodyInvoker()

Constructor Summary

Constructors

Constructor	Description
BodyInvoker()

Method Summary

Modifier and Type	Method	Description
static ConsoleLogFilter	mergeConsoleLogFilters(ConsoleLogFilter original, ConsoleLogFilter subsequent)	Merge two console log filters so that both are applied.
static LauncherDecorator	mergeLauncherDecorators(LauncherDecorator original, LauncherDecorator subsequent)	Merge two launcher decorators so that both are applied.
abstract BodyExecution	start()	Schedules an asynchronous invocation of the body that's given as an argument to the step invocation (in a host language dependent manner), with settings configured on this object via other methods.
BodyInvoker	withCallback(com.google.common.util.concurrent.FutureCallback<Object> callback)	Deprecated. Use withCallback(BodyExecutionCallback) and call BodyExecutionCallback.wrap(com.google.common.util.concurrent.FutureCallback<java.lang.Object>) if this is what you really wanted.
abstract BodyInvoker	withCallback(BodyExecutionCallback callback)	Registers a callback that tracks the progress of the body execution.
abstract BodyInvoker	withContext(Object override)	Overrides to the context values that are in effect while evaluating the body.
BodyInvoker	withContexts(Object... overrides)	Equivalent to calling withContext(java.lang.Object) on each object.
BodyInvoker	withContexts(Collection<?> overrides)	Equivalent to calling withContext(java.lang.Object) on each object.
abstract BodyInvoker	withDisplayName(String name)	Sets a human readable name that describes this body invocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BodyInvoker

public BodyInvoker()

Method Detail

withContext

public abstract BodyInvoker withContext(Object override)

Overrides to the context values that are in effect while evaluating the body.

Note that only one instance of a given class can be in the context at a time. Thus for certain types, an invoker will generally need to look up any instance in its own enclosing context amd create a proxy/merge:

EnvVars

use EnvironmentExpander instead

EnvironmentExpander

use EnvironmentExpander.merge(org.jenkinsci.plugins.workflow.steps.EnvironmentExpander, org.jenkinsci.plugins.workflow.steps.EnvironmentExpander)

ConsoleLogFilter

use mergeConsoleLogFilters(hudson.console.ConsoleLogFilter, hudson.console.ConsoleLogFilter)

LauncherDecorator

use mergeLauncherDecorators(hudson.LauncherDecorator, hudson.LauncherDecorator)

Returns:

this object

See Also:

StepContext.get(Class)

withContexts

public BodyInvoker withContexts(Object... overrides)

Equivalent to calling withContext(java.lang.Object) on each object.

withContexts

public BodyInvoker withContexts(Collection<?> overrides)

Equivalent to calling withContext(java.lang.Object) on each object.

withDisplayName

public abstract BodyInvoker withDisplayName(@NonNull
                                            String name)

Sets a human readable name that describes this body invocation. By default, this body invocation is anonymous.

Returns:

this object

withCallback

public abstract BodyInvoker withCallback(BodyExecutionCallback callback)

Registers a callback that tracks the progress of the body execution.

Returns:

this object

withCallback

public final BodyInvoker withCallback(com.google.common.util.concurrent.FutureCallback<Object> callback)

Deprecated.

Use withCallback(BodyExecutionCallback) and call BodyExecutionCallback.wrap(com.google.common.util.concurrent.FutureCallback<java.lang.Object>) if this is what you really wanted.

start

public abstract BodyExecution start()

Schedules an asynchronous invocation of the body that's given as an argument to the step invocation (in a host language dependent manner), with settings configured on this object via other methods.

mergeConsoleLogFilters

public static ConsoleLogFilter mergeConsoleLogFilters(@CheckForNull
                                                      ConsoleLogFilter original,
                                                      @NonNull
                                                      ConsoleLogFilter subsequent)

Merge two console log filters so that both are applied.

Parameters:

original - the original filter in StepContext.get(java.lang.Class<T>), if any

subsequent - your implementation; should expect null for the build parameter, and be Serializable

Returns:

a merge of the two, or just yours if there was no original

See Also:

withContext(java.lang.Object)

mergeLauncherDecorators

public static LauncherDecorator mergeLauncherDecorators(@CheckForNull
                                                        LauncherDecorator original,
                                                        @NonNull
                                                        LauncherDecorator subsequent)

Merge two launcher decorators so that both are applied.

Parameters:

original - the original decorator in StepContext.get(java.lang.Class<T>), if any

subsequent - your implementation; should be Serializable

Returns:

a merge of the two, or just yours if there was no original

See Also:

withContext(java.lang.Object)