Package io.jenkins.plugins.signpath

Class SubmitSigningRequestStep

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.Step

io.jenkins.plugins.signpath.SignPathStepBase

io.jenkins.plugins.signpath.SubmitSigningRequestStep

All Implemented Interfaces:

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

public class SubmitSigningRequestStep
extends SignPathStepBase

Represents the submitSigningRequestStep step that is executable via pipeline-script Encapsulates both the sync and async version of the step -> thus the waitForCompletion param is used to toggle between the two modes For a how-to use example see *EndToEnd tests

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubmitSigningRequestStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SubmitSigningRequestStep()

Method Summary

Modifier and Type	Method	Description
String	getArtifactConfigurationSlug()
String	getDescription()
SubmitSigningRequestStep.DescriptorImpl	getDescriptor()
String	getInputArtifactPath()
Map<String,String>	getInputArtifactRetrievalHttpHeaders()
String	getInputArtifactRetrievalUrl()
String	getOrganizationId()
String	getOrganizationIdWithGlobal()
String	getOutputArtifactPath()
Map<String,String>	getParameters()
String	getProjectSlug()
String	getSigningPolicySlug()
boolean	getWaitForCompletion()
void	setArtifactConfigurationSlug(String artifactConfigurationSlug)
void	setDescription(String description)
void	setInputArtifactPath(String inputArtifactPath)
void	setInputArtifactRetrievalHttpHeaders(Map<String,String> inputArtifactRetrievalHttpHeaders)
void	setInputArtifactRetrievalUrl(String inputArtifactRetrievalUrl)
void	setOrganizationId(String organizationId)
void	setOutputArtifactPath(String outputArtifactPath)
void	setParameters(Map<String,String> parameters)
void	setProjectSlug(String projectSlug)
void	setSigningPolicySlug(String signingPolicySlug)
void	setWaitForCompletion(boolean waitForCompletion)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class io.jenkins.plugins.signpath.SignPathStepBase

ensureNotNull, ensureValidURL, ensureValidUUID, getAndValidateApiConfiguration, getApiTokenCredentialId, getApiUrl, getApiUrlWithGlobal, getServiceUnavailableTimeoutInSeconds, getSignPathConfig, getTrustedBuildSystemTokenCredentialId, getTrustedBuildSystemTokenCredentialIdWithGlobal, getUploadAndDownloadRequestTimeoutInSeconds, getWaitBetweenReadinessChecksInSeconds, getWaitForCompletionTimeoutInSeconds, getWithGlobalConfig, logStepParameterDeprecationWarning, setApiTokenCredentialId, setApiUrl, setServiceUnavailableTimeoutInSeconds, setTrustedBuildSystemTokenCredentialId, setUploadAndDownloadRequestTimeoutInSeconds, setWaitForCompletionTimeoutInSeconds

Methods inherited from class java.lang.Object

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

Constructor Details

SubmitSigningRequestStep

@DataBoundConstructor
public SubmitSigningRequestStep()

Method Details

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws IOException,
InterruptedException,
SignPathStepInvalidArgumentException

Specified by:

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

Throws:

IOException

InterruptedException

SignPathStepInvalidArgumentException

getDescriptor

public SubmitSigningRequestStep.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<org.jenkinsci.plugins.workflow.steps.Step>

Overrides:

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

getOrganizationId

public String getOrganizationId()

getOrganizationIdWithGlobal

public String getOrganizationIdWithGlobal()
                                   throws SignPathStepInvalidArgumentException

Throws:

SignPathStepInvalidArgumentException

getProjectSlug

public String getProjectSlug()

getArtifactConfigurationSlug

public String getArtifactConfigurationSlug()

getSigningPolicySlug

public String getSigningPolicySlug()

getInputArtifactPath

public String getInputArtifactPath()

getDescription

public String getDescription()

getWaitForCompletion

public boolean getWaitForCompletion()

getOutputArtifactPath

public String getOutputArtifactPath()

getParameters

public Map<String,String> getParameters()

getInputArtifactRetrievalUrl

public String getInputArtifactRetrievalUrl()

getInputArtifactRetrievalHttpHeaders

public Map<String,String> getInputArtifactRetrievalHttpHeaders()

setOrganizationId

@DataBoundSetter
public void setOrganizationId(String organizationId)

setProjectSlug

@DataBoundSetter
public void setProjectSlug(String projectSlug)

setArtifactConfigurationSlug

@DataBoundSetter
public void setArtifactConfigurationSlug(String artifactConfigurationSlug)

setSigningPolicySlug

@DataBoundSetter
public void setSigningPolicySlug(String signingPolicySlug)

setInputArtifactPath

@DataBoundSetter
public void setInputArtifactPath(String inputArtifactPath)

setDescription

@DataBoundSetter
public void setDescription(String description)

setWaitForCompletion

@DataBoundSetter
public void setWaitForCompletion(boolean waitForCompletion)

setOutputArtifactPath

@DataBoundSetter
public void setOutputArtifactPath(String outputArtifactPath)

setParameters

@DataBoundSetter
public void setParameters(Map<String,String> parameters)

setInputArtifactRetrievalUrl

@DataBoundSetter
public void setInputArtifactRetrievalUrl(String inputArtifactRetrievalUrl)

setInputArtifactRetrievalHttpHeaders

@DataBoundSetter
public void setInputArtifactRetrievalHttpHeaders(Map<String,String> inputArtifactRetrievalHttpHeaders)