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

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

public class InputStepExecution
extends org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
implements ModelObject

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputStepExecution()

Method Summary

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doAbort() REST endpoint to abort the workflow.
org.kohsuke.stapler.HttpResponse	doProceed(org.kohsuke.stapler.StaplerRequest request) REST endpoint to submit the input.
org.kohsuke.stapler.HttpResponse	doProceedEmpty() Used from the Proceed hyperlink when no parameters are defined.
org.kohsuke.stapler.HttpResponse	doSubmit(org.kohsuke.stapler.StaplerRequest request) Called from the form via browser to submit/abort this input step.
String	getDisplayName()
String	getId()
InputStep	getInput()
Run	getRun()
boolean	isSettled() If this input step has been decided one way or the other.
void	preSubmissionCheck() Check if the current user can submit the input.
org.kohsuke.stapler.HttpResponse	proceed(Map<String,Object> params) Processes the acceptance (approval) request.
org.kohsuke.stapler.HttpResponse	proceed(Object v) Deprecated.
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 java.lang.Object

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

Constructor Detail

InputStepExecution

public InputStepExecution()

Method Detail

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

public String getId()

getInput

public InputStep getInput()

getRun

public Run getRun()

isSettled

public boolean isSettled()

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

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

doSubmit

public org.kohsuke.stapler.HttpResponse doSubmit(org.kohsuke.stapler.StaplerRequest request)
                                          throws IOException,
                                                 javax.servlet.ServletException,
                                                 InterruptedException

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

Throws:

IOException

javax.servlet.ServletException

InterruptedException

doProceed

public org.kohsuke.stapler.HttpResponse doProceed(org.kohsuke.stapler.StaplerRequest request)
                                           throws IOException,
                                                  javax.servlet.ServletException,
                                                  InterruptedException

REST endpoint to submit the input.

Throws:

IOException

javax.servlet.ServletException

InterruptedException

proceed

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

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

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.

proceed

@Deprecated
public org.kohsuke.stapler.HttpResponse proceed(Object v)

Deprecated.

doProceedEmpty

public org.kohsuke.stapler.HttpResponse doProceedEmpty()
                                                throws IOException

Used from the Proceed hyperlink when no parameters are defined.

Throws:

IOException

doAbort

public org.kohsuke.stapler.HttpResponse doAbort()

REST endpoint to abort the workflow.

preSubmissionCheck

public void preSubmissionCheck()

Check if the current user can submit the input.