TemplatePrimitiveInjector (templating-engine-plugin 2.5.5 API)

org.boozallen.plugins.jte.init.primitives.TemplatePrimitiveInjector

All Implemented Interfaces and Traits:

hudson.ExtensionPoint
```
@java.lang.SuppressWarnings(['EmptyMethodInAbstractClass', 'UnusedMethodParameter'])
abstract class TemplatePrimitiveInjector
extends java.lang.Object
```
Extension to hook into the initialization process to parse the pipeline configuration, create TemplatePrimitives, and validate them after creation

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static hudson.ExtensionList<TemplatePrimitiveInjector>`	`all()` fetches all registered TemplatePrimitiveInjectors
	`TemplatePrimitiveCollector`	`getPrimitiveCollector(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)`
	`TemplatePrimitiveNamespace`	`injectPrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)` parse the aggregated pipeline configuration to instantiate a TemplatePrimitive and store it in a TemplatePrimitiveNamespace
	`static void`	`orchestrate(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)` Triggers the 3-phase initialization process by iterating over all registered injectors
	`static java.lang.Class`	`parseClass(java.lang.String classText)` Used to compile pipeline primitives using the CPS transformer.
	`void`	`validateConfiguration(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)` Used to validate the pipeline configuration is structurally correct
	`void`	`validatePrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config, TemplatePrimitiveCollector collector)` A second pass allowing the different injector's to inspect what TemplatePrimitives have been created and respond accordingly

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - static hudson.ExtensionList<TemplatePrimitiveInjector> all()
    
    fetches all registered TemplatePrimitiveInjectors
    Returns:
    list of TemplatePrimitiveInjectors
  - TemplatePrimitiveCollector getPrimitiveCollector(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)
  - TemplatePrimitiveNamespace injectPrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)
    
    parse the aggregated pipeline configuration to instantiate a TemplatePrimitive and store it in a TemplatePrimitiveNamespace
    Parameters:
    flowOwner - the run's flowOwner
    config - the aggregated pipeline configuration
  - static void orchestrate(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)
    
    Triggers the 3-phase initialization process by iterating over all registered injectors
    Parameters:
    flowOwner - the run's FlowExecutionOwner
    config - the aggregated pipeline configuration
  - static java.lang.Class parseClass(java.lang.String classText)
    
    Used to compile pipeline primitives using the CPS transformer.
    Parameters:
    classText - the source code text
    Returns:
    the Class represented by classText
  - void validateConfiguration(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)
    
    Used to validate the pipeline configuration is structurally correct
    Parameters:
    exec - the current CpsFlowExecution
    config - the aggregated pipeline configuration
  - void validatePrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config, TemplatePrimitiveCollector collector)
    
    A second pass allowing the different injector's to inspect what TemplatePrimitives have been created and respond accordingly
    Parameters:
    flowOwner - the run's flowOwner
    config - the aggregated pipeline configuration

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class TemplatePrimitiveInjector

Methods Summary

Inherited Methods Summary

Method Detail

static hudson.ExtensionList<TemplatePrimitiveInjector> all()

TemplatePrimitiveCollector getPrimitiveCollector(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec)

TemplatePrimitiveNamespace injectPrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)

static void orchestrate(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)

static java.lang.Class parseClass(java.lang.String classText)

void validateConfiguration(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config)

void validatePrimitives(org.jenkinsci.plugins.workflow.cps.CpsFlowExecution exec, PipelineConfigurationObject config, TemplatePrimitiveCollector collector)