StepWrapperScript (templating-engine-plugin 2.5.5 API)

org.boozallen.plugins.jte.init.primitives.injectors.StepWrapperScript

The base script used during step execution context fields are set at runtime in StepWrapperCPS

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`StepWrapperScript.ConfigReservedVariable`	reserves the config var from being overridden in the binding
`static class`	`StepWrapperScript.HookContextReservedVariable`	reserves the config var from being overridden in the binding
`static class`	`StepWrapperScript.ResourceReservedVariable`	reserves the config var from being overridden in the binding
`static class`	`StepWrapperScript.StageContextReservedVariable`	reserves the config var from being overridden in the binding
`static class`	`StepWrapperScript.StepContextReservedVariable`	reserves the config var from being overridden in the binding

Constructor Summary

Constructors
Constructor and description
`StepWrapperScript ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`hudson.model.Run<?, ?>`	`$build()`
	`hudson.model.Run<?, ?>`	`$buildNoException()`
	`java.util.LinkedHashMap`	`getConfig()`
	`HookContext`	`getHookContext()`
	`StageContext`	`getStageContext()`
	`StepContext`	`getStepContext()`
	`java.lang.String`	`resource(java.lang.String path)` Used within steps to access library resources
	`void`	`setBuildRootDir(java.io.File rootDir)`
	`void`	`setConfig(java.util.LinkedHashMap config)`
	`void`	`setHookContext(HookContext hookContext)`
	`void`	`setResourcesPath(java.lang.String resourcesPath)`
	`void`	`setStageContext(StageContext stageContext)`
	`void`	`setStepContext(StepContext stepContext)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.jenkinsci.plugins.workflow.cps.CpsScript`	org.jenkinsci.plugins.workflow.cps.CpsScript#println(), org.jenkinsci.plugins.workflow.cps.CpsScript#println(java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#run(java.io.File, [Ljava.lang.String;), org.jenkinsci.plugins.workflow.cps.CpsScript#getProperty(java.lang.String), org.jenkinsci.plugins.workflow.cps.CpsScript#sleep(long), org.jenkinsci.plugins.workflow.cps.CpsScript#print(java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#printf(java.lang.String, [Ljava.lang.Object;), org.jenkinsci.plugins.workflow.cps.CpsScript#printf(java.lang.String, java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#evaluate(java.io.File), org.jenkinsci.plugins.workflow.cps.CpsScript#evaluate(java.lang.String), org.jenkinsci.plugins.workflow.cps.CpsScript#$build(), org.jenkinsci.plugins.workflow.cps.CpsScript#invokeMethod(java.lang.String, java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#$buildNoException(), org.jenkinsci.plugins.workflow.cps.CpsScript#run(), org.jenkinsci.plugins.workflow.cps.CpsScript#setProperty(java.lang.String, java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#getBinding(), org.jenkinsci.plugins.workflow.cps.CpsScript#setBinding(groovy.lang.Binding), org.jenkinsci.plugins.workflow.cps.CpsScript#getMetaClass(), org.jenkinsci.plugins.workflow.cps.CpsScript#setMetaClass(groovy.lang.MetaClass), org.jenkinsci.plugins.workflow.cps.CpsScript#wait(long), org.jenkinsci.plugins.workflow.cps.CpsScript#wait(long, int), org.jenkinsci.plugins.workflow.cps.CpsScript#wait(), org.jenkinsci.plugins.workflow.cps.CpsScript#equals(java.lang.Object), org.jenkinsci.plugins.workflow.cps.CpsScript#toString(), org.jenkinsci.plugins.workflow.cps.CpsScript#hashCode(), org.jenkinsci.plugins.workflow.cps.CpsScript#getClass(), org.jenkinsci.plugins.workflow.cps.CpsScript#notify(), org.jenkinsci.plugins.workflow.cps.CpsScript#notifyAll()
`class com.cloudbees.groovy.cps.SerializableScript`	com.cloudbees.groovy.cps.SerializableScript#println(), com.cloudbees.groovy.cps.SerializableScript#println(java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#run(java.io.File, [Ljava.lang.String;), com.cloudbees.groovy.cps.SerializableScript#run(), com.cloudbees.groovy.cps.SerializableScript#getProperty(java.lang.String), com.cloudbees.groovy.cps.SerializableScript#setProperty(java.lang.String, java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#print(java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#printf(java.lang.String, [Ljava.lang.Object;), com.cloudbees.groovy.cps.SerializableScript#printf(java.lang.String, java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#evaluate(java.lang.String), com.cloudbees.groovy.cps.SerializableScript#evaluate(java.io.File), com.cloudbees.groovy.cps.SerializableScript#getBinding(), com.cloudbees.groovy.cps.SerializableScript#setBinding(groovy.lang.Binding), com.cloudbees.groovy.cps.SerializableScript#invokeMethod(java.lang.String, java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#getMetaClass(), com.cloudbees.groovy.cps.SerializableScript#setMetaClass(groovy.lang.MetaClass), com.cloudbees.groovy.cps.SerializableScript#wait(long), com.cloudbees.groovy.cps.SerializableScript#wait(long, int), com.cloudbees.groovy.cps.SerializableScript#wait(), com.cloudbees.groovy.cps.SerializableScript#equals(java.lang.Object), com.cloudbees.groovy.cps.SerializableScript#toString(), com.cloudbees.groovy.cps.SerializableScript#hashCode(), com.cloudbees.groovy.cps.SerializableScript#getClass(), com.cloudbees.groovy.cps.SerializableScript#notify(), com.cloudbees.groovy.cps.SerializableScript#notifyAll()

- Constructor Detail
  - public StepWrapperScript()
- Method Detail
  - @java.lang.Override public hudson.model.Run<?, ?> $build()
  - @java.lang.Override public hudson.model.Run<?, ?> $buildNoException()
  - public java.util.LinkedHashMap getConfig()
  - public HookContext getHookContext()
  - public StageContext getStageContext()
  - public StepContext getStepContext()
  - public java.lang.String resource(java.lang.String path)
    
    Used within steps to access library resources
    throws:
    java.io.IOException throws this
    throws:
    java.lang.InterruptedException throws this
    
    Parameters:
    path - relative path within the resources directory to fetch
    Returns:
    the resource file contents
  - public void setBuildRootDir(java.io.File rootDir)
  - public void setConfig(java.util.LinkedHashMap config)
  - public void setHookContext(HookContext hookContext)
  - public void setResourcesPath(java.lang.String resourcesPath)
  - public void setStageContext(StageContext stageContext)
  - public void setStepContext(StepContext stepContext)

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class StepWrapperScript

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public StepWrapperScript()

Method Detail

@java.lang.Override public hudson.model.Run<?, ?> $build()

@java.lang.Override public hudson.model.Run<?, ?> $buildNoException()

public java.util.LinkedHashMap getConfig()

public HookContext getHookContext()

public StageContext getStageContext()

public StepContext getStepContext()

public java.lang.String resource(java.lang.String path)

public void setBuildRootDir(java.io.File rootDir)

public void setConfig(java.util.LinkedHashMap config)

public void setHookContext(HookContext hookContext)

public void setResourcesPath(java.lang.String resourcesPath)

public void setStageContext(StageContext stageContext)

public void setStepContext(StepContext stepContext)