Package com.microsoft.jenkins.azurecommons.command

Class BaseCommandContext

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.microsoft.jenkins.azurecommons.command.BaseCommandContext

All Implemented Interfaces:

IBaseCommandData, ICommandServiceData, ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public abstract class BaseCommandContext
extends org.jenkinsci.plugins.workflow.steps.Step
implements ICommandServiceData, IBaseCommandData

A mixed abstract base class with both command data and command service data.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BaseCommandContext()

Method Summary

Modifier and Type	Method	Description
protected void	configure(JobContext jobCtx, CommandService aCommandService)
protected void	configure(Run<?,?> aRun, FilePath aWorkspace, Launcher aLauncher, TaskListener aTaskListener, CommandService aCommandService)
void	executeCommands()
CommandService	getCommandService()
CommandState	getCommandState()	Get the command state for the associated completed command.
abstract IBaseCommandData	getDataForCommand(ICommand command)
EnvVars	getEnvVars()	When running from pipeline, the result returned from Run.getEnvironment(TaskListener) won't include the system environments set by the env.VAR=value or withEnv(['VAR=value']).
JobContext	getJobContext()
CommandState	getLastCommandState()	Get the command state for the last command being executed.
void	logError(Exception ex)
void	logError(String message)
void	logError(String prefix, Exception ex)
void	logStatus(String status)
void	setCommandState(CommandState commandState)	Set the command state for the associated running command.
void	setLastCommandState(CommandState lastCommandState)	Set the command state for the last command being executed in the command service.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)	Pipeline function call entrance.
abstract org.jenkinsci.plugins.workflow.steps.StepExecution	startImpl(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCommandContext

public BaseCommandContext()

Method Detail

configure

protected void configure(Run<?,?> aRun,
                         FilePath aWorkspace,
                         Launcher aLauncher,
                         TaskListener aTaskListener,
                         CommandService aCommandService)

configure

protected void configure(JobContext jobCtx,
                         CommandService aCommandService)

start

public final org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                               throws Exception

Pipeline function call entrance.

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Parameters:

context - the pipeline step context

Returns:

the execution logic object.

Throws:

Exception

startImpl

public abstract org.jenkinsci.plugins.workflow.steps.StepExecution startImpl(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                                      throws Exception

Throws:

Exception

getEnvVars

public EnvVars getEnvVars()

When running from pipeline, the result returned from Run.getEnvironment(TaskListener) won't include the system environments set by the env.VAR=value or withEnv(['VAR=value']). We need to call StepContext.get(EnvVar.class) for the full environment variables set.

If the field is not null, we are running from pipeline and we use this as the source of environment variables; otherwise we fetch the environment variables from Run as normal.

Specified by:

getEnvVars in interface IBaseCommandData

executeCommands

public void executeCommands()

getDataForCommand

public abstract IBaseCommandData getDataForCommand(ICommand command)

Specified by:

getDataForCommand in interface ICommandServiceData

setCommandState

public void setCommandState(CommandState commandState)

Description copied from interface: IBaseCommandData

Set the command state for the associated running command.

Specified by:

setCommandState in interface IBaseCommandData

Parameters:

commandState - the result command state.

getCommandState

public CommandState getCommandState()

Description copied from interface: IBaseCommandData

Get the command state for the associated completed command.

Specified by:

getCommandState in interface IBaseCommandData

Returns:

the result command state.

getLastCommandState

public CommandState getLastCommandState()

Description copied from interface: ICommandServiceData

Get the command state for the last command being executed. This will be the state of the command service execution.

Specified by:

getLastCommandState in interface ICommandServiceData

See Also:

IBaseCommandData.getCommandState()

setLastCommandState

public void setLastCommandState(CommandState lastCommandState)

Description copied from interface: ICommandServiceData

Set the command state for the last command being executed in the command service.

Specified by:

setLastCommandState in interface ICommandServiceData

Parameters:

lastCommandState - the last command state.

See Also:

IBaseCommandData.setCommandState(CommandState)

getCommandService

public CommandService getCommandService()

Specified by:

getCommandService in interface ICommandServiceData

getJobContext

public final JobContext getJobContext()

Specified by:

getJobContext in interface IBaseCommandData

logStatus

public void logStatus(String status)

Specified by:

logStatus in interface IBaseCommandData

logError

public void logError(Exception ex)

Specified by:

logError in interface IBaseCommandData

logError

public void logError(String prefix,
                     Exception ex)

Specified by:

logError in interface IBaseCommandData

logError

public void logError(String message)

Specified by:

logError in interface IBaseCommandData