org.jenkinsci.plugins.ParameterizedRemoteTrigger

Class BuildContext

java.lang.Object

org.jenkinsci.plugins.ParameterizedRemoteTrigger.BasicBuildContext

org.jenkinsci.plugins.ParameterizedRemoteTrigger.BuildContext

@ParametersAreNullableByDefault
public class BuildContext
extends BasicBuildContext

This object wraps a Run, FilePath, TaskListener and PrintStream - the typical objects passed from one method to the other in a Jenkins Builder/BuildStep implementation.

The reason for wrapping is simplicity on the one hand. On the other in an asynchronous pipeline usage via the Handle we might not have a Run, FilePath, TaskListener, but we still want to provide a PrintStream for logging. Therefore the first three objects can be null, the PrintStream must not be null.

Field Summary

Fields

Modifier and Type	Field and Description
String	currentItem The current Item (job, pipeline,...) where the plugin is used from.
RemoteJenkinsServer	effectiveRemoteServer
PrintStream	logger

Fields inherited from class org.jenkinsci.plugins.ParameterizedRemoteTrigger.BasicBuildContext

listener, run, workspace

Constructor Summary

Constructors

Constructor and Description
BuildContext(PrintStream logger, RemoteJenkinsServer effectiveRemoteServer, String currentItem)
BuildContext(Run<?,?> run, FilePath workspace, TaskListener listener, PrintStream logger, RemoteJenkinsServer effectiveRemoteServer)
BuildContext(Run<?,?> run, FilePath workspace, TaskListener listener, PrintStream logger, RemoteJenkinsServer effectiveRemoteServer, String currentItem)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

logger

@Nonnull
public final PrintStream logger

effectiveRemoteServer

@Nonnull
public RemoteJenkinsServer effectiveRemoteServer

currentItem

@Nonnull
public final String currentItem

The current Item (job, pipeline,...) where the plugin is used from.

Constructor Detail

BuildContext

public BuildContext(@Nullable
                    Run<?,?> run,
                    @Nullable
                    FilePath workspace,
                    @Nullable
                    TaskListener listener,
                    @Nonnull
                    PrintStream logger,
                    @Nonnull
                    RemoteJenkinsServer effectiveRemoteServer,
                    @Nullable
                    String currentItem)

BuildContext

public BuildContext(@Nullable
                    Run<?,?> run,
                    @Nullable
                    FilePath workspace,
                    @Nullable
                    TaskListener listener,
                    @Nonnull
                    PrintStream logger,
                    @Nonnull
                    RemoteJenkinsServer effectiveRemoteServer)

BuildContext

public BuildContext(@Nonnull
                    PrintStream logger,
                    @Nonnull
                    RemoteJenkinsServer effectiveRemoteServer,
                    @Nullable
                    String currentItem)