Class InputStepExecution

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

org.jenkinsci.plugins.workflow.support.steps.input.InputStepExecution

All Implemented Interfaces:

ModelObject, Serializable

@ExportedBean(defaultVisibility=2)
public class InputStepExecution
extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
implements ModelObject

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doAbort()	Deprecated. use doAbort(StaplerRequest2,StaplerResponse2)
org.kohsuke.stapler.HttpResponse	doAbort(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 rsp)	REST endpoint to abort the workflow.
org.kohsuke.stapler.HttpResponse	doDialogSubmit(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 rsp)	Called from the console page for submitting the step when it has parameters.
org.kohsuke.stapler.HttpResponse	doProceed(org.kohsuke.stapler.StaplerRequest req)	Deprecated. use doProceed(StaplerRequest2,StaplerResponse2)
org.kohsuke.stapler.HttpResponse	doProceed(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 rsp)	REST endpoint to submit the input.
org.kohsuke.stapler.HttpResponse	doProceedEmpty()	Deprecated. use doProceedEmpty(StaplerRequest2, StaplerResponse2)
org.kohsuke.stapler.HttpResponse	doProceedEmpty(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 rsp)	Used from the Proceed hyperlink when no parameters are defined.
org.kohsuke.stapler.HttpResponse	doSubmit(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 rsp)	Called from the form via browser to submit/abort this input step.
String	getDisplayName()
boolean	getHasUnsafeId()
boolean	getHasUnsafeParameters()
String	getId()
InputStep	getInput()
Run<?,?>	getRun()
boolean	isSettled()	If this input step has been decided one way or the other.
void	preSubmissionCheck()	Deprecated. use preSubmissionCheck(StaplerRequest2)
org.kohsuke.stapler.HttpResponse	preSubmissionCheck(org.kohsuke.stapler.StaplerRequest2 request)	Check if the current user can submit the input.
org.kohsuke.stapler.HttpResponse	proceed(Object v)	Deprecated.
org.kohsuke.stapler.HttpResponse	proceed(Map<String,Object> params)	Processes the acceptance (approval) request.
boolean	start()
void	stop(Throwable cause)

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

inject, onResume

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

applyAll, applyAll, blocksRestart, getContext, getStatus, getStatusBounded

Methods inherited from class Object

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

Method Details

start

public boolean start()
              throws Exception

Specified by:

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

Throws:

Exception

stop

public void stop(Throwable cause)
          throws Exception

Overrides:

stop in class org.jenkinsci.plugins.workflow.steps.StepExecution

Throws:

Exception

getId

@Exported
public String getId()

getInput

@Exported
public InputStep getInput()

getRun

public Run<?,?> getRun()
                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

isSettled

@Exported
public boolean isSettled()

If this input step has been decided one way or the other.

getDisplayName

@Exported
public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

doSubmit

public org.kohsuke.stapler.HttpResponse doSubmit(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                          throws IOException,
jakarta.servlet.ServletException,
InterruptedException

Called from the form via browser to submit/abort this input step.

Throws:

IOException

jakarta.servlet.ServletException

InterruptedException

doDialogSubmit

public org.kohsuke.stapler.HttpResponse doDialogSubmit(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                                throws IOException,
jakarta.servlet.ServletException,
InterruptedException

Called from the console page for submitting the step when it has parameters.

Throws:

IOException

jakarta.servlet.ServletException

InterruptedException

doProceed

public org.kohsuke.stapler.HttpResponse doProceed(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                           throws IOException,
jakarta.servlet.ServletException,
InterruptedException

REST endpoint to submit the input.

Throws:

IOException

jakarta.servlet.ServletException

InterruptedException

doProceed

@Deprecated
@StaplerNotDispatchable
public org.kohsuke.stapler.HttpResponse doProceed(org.kohsuke.stapler.StaplerRequest req)
                                           throws IOException,
javax.servlet.ServletException,
InterruptedException

Deprecated.

use doProceed(StaplerRequest2,StaplerResponse2)

Throws:

IOException

javax.servlet.ServletException

InterruptedException

proceed

public org.kohsuke.stapler.HttpResponse proceed(@CheckForNull
 Map<String,Object> params)
                                         throws IOException,
InterruptedException

Processes the acceptance (approval) request. This method is used by both doProceedEmpty(StaplerRequest2, StaplerResponse2) and doProceed(StaplerRequest2, StaplerResponse2)

Parameters:

params - A map that represents the parameters sent in the request

Returns:

A HttpResponse object that represents Status code (200) indicating the request succeeded normally.

Throws:

IOException

InterruptedException

proceed

@Deprecated
public org.kohsuke.stapler.HttpResponse proceed(Object v)
                                         throws IOException,
InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

doProceedEmpty

@Deprecated
@StaplerNotDispatchable
public org.kohsuke.stapler.HttpResponse doProceedEmpty()
                                                throws IOException,
InterruptedException

Deprecated.

use doProceedEmpty(StaplerRequest2, StaplerResponse2)

Throws:

IOException

InterruptedException

doProceedEmpty

public org.kohsuke.stapler.HttpResponse doProceedEmpty(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                                throws IOException,
InterruptedException

Used from the Proceed hyperlink when no parameters are defined.

Throws:

IOException

InterruptedException

doAbort

@Deprecated
@StaplerNotDispatchable
public org.kohsuke.stapler.HttpResponse doAbort()
                                         throws IOException,
InterruptedException

Deprecated.

use doAbort(StaplerRequest2,StaplerResponse2)

Throws:

IOException

InterruptedException

doAbort

public org.kohsuke.stapler.HttpResponse doAbort(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                         throws IOException,
InterruptedException

REST endpoint to abort the workflow.

Throws:

IOException

InterruptedException

preSubmissionCheck

@Deprecated
public void preSubmissionCheck()
                        throws IOException,
InterruptedException

Deprecated.

use preSubmissionCheck(StaplerRequest2)

Throws:

IOException

InterruptedException

preSubmissionCheck

public org.kohsuke.stapler.HttpResponse preSubmissionCheck(org.kohsuke.stapler.StaplerRequest2 request)
                                                    throws IOException,
InterruptedException

Check if the current user can submit the input.

Returns:

Throws:

IOException

InterruptedException

getHasUnsafeParameters

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean getHasUnsafeParameters()

getHasUnsafeId

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean getHasUnsafeId()