Package org.jenkinsci.plugins.workflow.libs

Class ResourceStep

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.libs.ResourceStep

All Implemented Interfaces:

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

public class ResourceStep
extends org.jenkinsci.plugins.workflow.steps.Step

Step to load a resource from a library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceStep.DescriptorImpl
static class	ResourceStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ResourceStep(String resource)

Method Summary

Modifier and Type	Method	Description
String	getEncoding()
String	getResource()
void	setEncoding(String encoding)	Set the encoding to be used when loading the resource.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(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 Details

ResourceStep

@DataBoundConstructor
public ResourceStep(String resource)

Method Details

getResource

public String getResource()

getEncoding

@CheckForNull
public String getEncoding()

setEncoding

@DataBoundSetter
public void setEncoding(String encoding)

Set the encoding to be used when loading the resource. If the specified value is null or whitespace-only, then the platform default encoding will be used. Binary resources can be loaded as a Base64-encoded string by specifying Base64 as the encoding.

start

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

Specified by:

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

Throws:

Exception