Index (templating-engine-plugin 2.5.3 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

add(Exception) - Method in AggregateException
add(TemplatePrimitiveNamespace) - Method in LibraryNamespace
add(TemplatePrimitive) - Method in TemplatePrimitiveNamespace
addAliases() - Method in AdHocTemplateFlowDefinition.DescriptorImpl
addNamespace(TemplatePrimitiveNamespace) - Method in TemplatePrimitiveCollector
AdHocTemplateFlowDefinition - Class in org.boozallen.plugins.jte.job: Allows JTE to be used in a Pipeline Job
AdHocTemplateFlowDefinition.DescriptorImpl - Class in org.boozallen.plugins.jte.job
AdHocTemplateFlowDefinition.HideMeElsewhere - Class in org.boozallen.plugins.jte.job
AdHocTemplateFlowDefinition(AdHocTemplateFlowDefinitionConfiguration) - Constructor in AdHocTemplateFlowDefinition
AdHocTemplateFlowDefinitionConfiguration - Class in org.boozallen.plugins.jte.job
AdHocTemplateFlowDefinitionConfiguration.DescriptorImpl - Class in org.boozallen.plugins.jte.job
AfterStep - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks: Annotation marking a library step method to potentially execute after other step executions
aggregate() - Method in PipelineConfigurationAggregator
AggregateException - Class in org.boozallen.plugins.jte.util: A generic exception to mark an exception as coming from JTE
all() - Method in ReservedVariableName
all() - Method in TemplatePrimitiveInjector: fetches all registered TemplatePrimitiveInjectors
annotate(WorkflowRun, MarkupText, int) - Method in TemplateLogger.Annotator
ApplicationEnvironment - Class in org.boozallen.plugins.jte.init.primitives.injectors: JTE primitive representing an application environment to capture environmental context
ApplicationEnvironment(String, Map) - Constructor in ApplicationEnvironment
ApplicationEnvironmentInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: creates ApplicationEnvironments
asType(Class) - Method in FileSystemWrapper

B

BeforeStep - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks: Annotation marking a library step method to potentially execute before other step executions
BINDING_VARS - Field in PipelineConfigurationBuilder
byName(String) - Method in ReservedVariableName

C

call(String) - Method in PipelineConfigurationBuilder.BuilderMethod

checkForGlobalVariableCollisions(Map<String, List<TemplatePrimitive>>, FlowExecutionOwner, TemplateLogger) - Method in GlobalCollisionValidator

checkForJenkinsStepCollisions(Map<String, List<TemplatePrimitive>>, TemplateLogger) - Method in GlobalCollisionValidator

checkForPrimitiveCollisions(Map<String, List<TemplatePrimitive>>, PipelineConfigurationObject, TemplateLogger) - Method in GlobalCollisionValidator

checkPrimitiveCollision(String) - Method in TemplateBinding

checkReservedVariables(String) - Method in TemplateBinding

CleanUp - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks

Annotation marking a library step method to potentially execute after pipeline template execution

CONFIG_FILE - Field in LibraryProvider

the library configuration file path

config - Field in StepWrapper

The library configuration

configureCompiler(CpsFlowExecution, CompilerConfiguration) - Method in PipelineTemplateCompiler

For the JTE pipeline template, customizes the compiler so that the template is wrapped in a try-finally block so that the

Validation:: and

Init:: Lifecycle Hooks can be invoked prior to template execution and

CleanUp:: and

@Notify Lifecycle Hooks can be invoked post template execution.

configureShell(CpsFlowExecution, GroovyShell) - Method in StepWrapperFactory.StepWrapperShellDecorator

ConfigValidator - Class in org.boozallen.plugins.jte.util

Utility to validate a map against a provided schema

ConfigValidator(FlowExecutionOwner, String) - Constructor in ConfigValidator

ConsoleAdHocTemplateFlowDefinitionConfiguration - Class in org.boozallen.plugins.jte.job

Defines a pipeline configuration repository from the Jenkins console.

ConsoleAdHocTemplateFlowDefinitionConfiguration.DescriptorImpl - Class in org.boozallen.plugins.jte.job

ConsoleAdHocTemplateFlowDefinitionConfiguration(ConsoleDefaultPipelineTemplate, ConsolePipelineConfiguration) - Constructor in ConsoleAdHocTemplateFlowDefinitionConfiguration

ConsoleDefaultPipelineTemplate - Class in org.boozallen.plugins.jte.init.governance.config

A named pipeline template defined in the Jenkins console.

ConsoleDefaultPipelineTemplate.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config

ConsoleDefaultPipelineTemplate(boolean, String) - Constructor in ConsoleDefaultPipelineTemplate

ConsoleNamedPipelineTemplate - Class in org.boozallen.plugins.jte.init.governance.config

A named pipeline template defined in the Jenkins console.

ConsoleNamedPipelineTemplate.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config

ConsoleNamedPipelineTemplate() - Constructor in ConsoleNamedPipelineTemplate

ConsolePipelineConfiguration - Class in org.boozallen.plugins.jte.init.governance.config

A named pipeline template defined in the Jenkins console.

ConsolePipelineConfiguration.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config

ConsolePipelineConfiguration(boolean, String) - Constructor in ConsolePipelineConfiguration

ConsolePipelineConfigurationProvider - Class in org.boozallen.plugins.jte.init.governance.config

Defines a pipeline configuration repository from the Jenkins console.

ConsolePipelineConfigurationProvider.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config

ConsolePipelineConfigurationProvider(ConsoleDefaultPipelineTemplate, ConsolePipelineConfiguration, List<ConsoleNamedPipelineTemplate>) - Constructor in ConsolePipelineConfigurationProvider

copy(Run<?, ?>, Run<?, ?>, TaskListener) - Method in TemplatePrimitiveCollector.CopyTemplatePrimitiveCollector

create(boolean, String, boolean, String) - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration

create(FlowExecutionOwner, SCM) - Method in FileSystemWrapperFactory

Creates a FileSystemWrapper.

create(FlowExecutionOwner) - Method in TemplateBinding

create(FlowExecutionOwner, TaskListener, List<? extends Action>) - Method in TemplateFlowDefinition

createDefaultStep(String, Map) - Method in StepWrapperFactory

Creates an instance of the default step implementation

createDefinition() - Method in TemplateBranchProjectFactory

createDuringRun() - Method in TemplateLogger

createFor(OrganizationFolder) - Method in TemplateMultiBranchProjectFactory.PerFolderAdder

createFromFilePath(FilePath, String, Map) - Method in StepWrapperFactory

takes a FilePath holding the source text for the step and creates a StepWrapper instance

createFs(FlowExecutionOwner) - Method in ScmLibraryProvider

createNullStep(String) - Method in StepWrapperFactory

Produces a no-op StepWrapper

current() - Method in TemplatePrimitiveCollector

During execution, this can be used to fetch the current run's TemplatePrimitiveCollector if present.

currentNoException() - Method in TemplatePrimitiveCollector

customize(WorkflowMultiBranchProject) - Method in TemplateMultiBranchProjectFactory

D

DefaultStepInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: creates instances of the default step implementation
determineFlowDurabilityHint(FlowExecutionOwner) - Method in TemplateFlowDefinition
doCreateProject(ItemGroup<?>, String, Map<String, Object>) - Method in TemplateMultiBranchProjectFactory
DslEnvVar - Class in org.boozallen.plugins.jte.init.governance.config.dsl: used to get environment variables
DslEnvVar(FlowExecutionOwner) - Constructor in DslEnvVar
dynamic() - Method in StepAlias: A closure whose result is a String or list of strings that are aliases for the step

E

ENV_VAR - Field in PipelineConfigurationBuilder

F

FileSystemWrapper - Class in org.boozallen.plugins.jte.util: Utility class to simplify fetching files from remote source code repositories, if the SCM plugin has implemented the Jenkins SCM API
FileSystemWrapperFactory - Class in org.boozallen.plugins.jte.util: Creates FileSystemWrappers
filter(Object, Descriptor) - Method in AdHocTemplateFlowDefinition.HideMeElsewhere
filter(Object, Descriptor) - Method in MultibranchTemplateFlowDefinition.HideMeElsewhere
filter(Object, Descriptor) - Method in PluginLibraryProvider.FilterImpl
findAll(Closure) - Method in TemplatePrimitiveCollector
forJob(Job) - Method in TemplatePrimitiveCollector.TemplatePrimitiveProvider: The forRun method is used to fetch variables everywhere that it matters
forRun(Run) - Method in TemplatePrimitiveCollector.TemplatePrimitiveProvider
forTrusted() - Method in StepWrapperFactory.StepWrapperShellDecorator

G

get() - Method in TemplateGlobalConfig
getAnnotatedMethodClass() - Method in HookInjector
getBaseDir() - Method in ScmLibraryProvider
getBaseDir() - Method in ScmPipelineConfigurationProvider
getCommonClassLoader(WorkflowRun, GroovyShell) - Method in StepWrapperFactory.StepWrapperShellDecorator
getConfig(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinitionConfiguration
getConfig(FlowExecutionOwner) - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
getConfig(FlowExecutionOwner) - Method in ConsolePipelineConfigurationProvider
getConfig(FlowExecutionOwner) - Method in GovernanceTier
getConfig(FlowExecutionOwner) - Method in NullPipelineConfigurationProvider
getConfig(FlowExecutionOwner) - Method in PipelineConfigurationProvider
getConfig(FlowExecutionOwner) - Method in ScmAdHocTemplateFlowDefinitionConfiguration
getConfig(FlowExecutionOwner) - Method in ScmPipelineConfigurationProvider
getConfig() - Method in StepWrapperScript
getConfigProvider() - Method in AdHocTemplateFlowDefinition
getConfigurationPath() - Method in MultibranchTemplateFlowDefinition
getConfigurationPath() - Method in TemplateBranchProjectFactory
getConfigurationPath() - Method in TemplateMultiBranchProjectFactory
getConfigurationProvider() - Method in GovernanceTier
getDefaultConfigurationProvider() - Method in AdHocTemplateFlowDefinition.DescriptorImpl
getDefaultConfigurationProvider() - Method in GovernanceTier.DescriptorImpl
getDefaultTemplate() - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
getDefaultTemplate() - Method in ConsoleDefaultPipelineTemplate
getDefaultTemplate() - Method in ConsolePipelineConfigurationProvider
getDescription() - Method in ReservedVariableName
getDescription() - Method in StepWrapperScript.ConfigReservedVariable
getDescription() - Method in StepWrapperScript.HookContextReservedVariable
getDescription() - Method in StepWrapperScript.ResourceReservedVariable
getDescription() - Method in StepWrapperScript.StageContextReservedVariable
getDescription() - Method in StepWrapperScript.StepContextReservedVariable
getDisplayName() - Method in AdHocTemplateFlowDefinition.DescriptorImpl
getDisplayName() - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration.DescriptorImpl
getDisplayName() - Method in ConsolePipelineConfigurationProvider.DescriptorImpl
getDisplayName() - Method in LibraryProvidingPlugin.LibraryProvidingPluginDescriptor
getDisplayName() - Method in MultibranchTemplateFlowDefinition.DescriptorImpl
getDisplayName() - Method in NullPipelineConfigurationProvider.DescriptorImpl
getDisplayName() - Method in PluginLibraryProvider.DescriptorImpl
getDisplayName() - Method in ScmAdHocTemplateFlowDefinitionConfiguration.DescriptorImpl
getDisplayName() - Method in ScmLibraryProvider.DescriptorImpl
getDisplayName() - Method in ScmPipelineConfigurationProvider.DescriptorImpl
getDisplayName() - Method in TemplateBranchProjectFactory.DescriptorDefaultImpl
getDisplayName() - Method in TemplateConfigFolderProperty.DescriptorImpl
getDisplayName() - Method in TemplateMultiBranchProjectFactory.DescriptorImpl
getExceptions() - Method in AggregateException
getFileContents(String, String, Boolean) - Method in FileSystemWrapper
getFileContents(ZipFile, ZipEntry) - Method in PluginLibraryProvider
getFilterBranches() - Method in TemplateBranchProjectFactory
getFilterBranches() - Method in TemplateMultiBranchProjectFactory
getGlobalVariablesByName(String, Run) - Method in TemplatePrimitiveCollector
getHierarchy(WorkflowJob) - Method in GovernanceTier
getHookContext() - Method in StepWrapperScript
getHooksClass() - Method in HookInjector
getJenkinsfile(FlowExecutionOwner) - Method in ConsolePipelineConfigurationProvider
getJenkinsfile(FlowExecutionOwner) - Method in GovernanceTier
getJenkinsfile(FlowExecutionOwner) - Method in NullPipelineConfigurationProvider
getJenkinsfile(FlowExecutionOwner) - Method in PipelineConfigurationProvider
getJenkinsfile(FlowExecutionOwner) - Method in ScmPipelineConfigurationProvider
getJobPipelineConfiguration() - Method in PipelineConfigurationAggregator
getJteBlockWrapper() - Method in PipelineConfigurationObject
getLibrary() - Method in StepWrapper
getLibraryProvider() - Method in LibrarySource
getLibraryProviders() - Method in GovernanceTier.DescriptorImpl
getLibraryProviders() - Method in LibrarySource.DescriptorImpl
getLibraryProvidingPlugins() - Method in PluginLibraryProvider.DescriptorImpl
getLibrarySchema(FlowExecutionOwner, String) - Method in LibraryProvider: Returns the contents of the library configuration file, if present.
getLibrarySchema(FlowExecutionOwner, String) - Method in PluginLibraryProvider
getLibrarySchema(FlowExecutionOwner, String) - Method in ScmLibraryProvider
getLibrarySources() - Method in GovernanceTier
getMessage() - Method in AggregateException
getName() - Method in ApplicationEnvironment
getName() - Method in ConsoleNamedPipelineTemplate
getName() - Method in Keyword
getName() - Method in PipelineConfigurationBuilder.BuilderMethod
getName() - Method in PipelineConfigVariableInjector.PipelineConfigGlobalVariable
getName() - Method in ReservedVariableName
getName() - Method in Stage
getName() - Method in StepWrapper
getName() - Method in StepWrapperScript.ConfigReservedVariable
getName() - Method in StepWrapperScript.HookContextReservedVariable
getName() - Method in StepWrapperScript.ResourceReservedVariable
getName() - Method in StepWrapperScript.StageContextReservedVariable
getName() - Method in StepWrapperScript.StepContextReservedVariable
getName() - Method in TemplatePrimitiveCollector.JTEVar
getName() - Method in TemplatePrimitiveCollector.StepsVar
getNamespace(String) - Method in TemplatePrimitiveCollector
getNestedKeys(LinkedHashMap, List<String>, String) - Method in ConfigValidator
getParent() - Method in TemplatePrimitiveNamespace
getParentChain() - Method in TemplatePrimitive
getPipelineCatalog() - Method in ConsolePipelineConfigurationProvider
getPipelineConfig() - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
getPipelineConfig() - Method in ConsolePipelineConfiguration
getPipelineConfig() - Method in ConsolePipelineConfigurationProvider
getPipelineConfiguration(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinition
getPipelineConfiguration(FlowExecutionOwner) - Method in MultibranchTemplateFlowDefinition
getPipelineConfiguration(FlowExecutionOwner) - Method in TemplateFlowDefinition: Fetch the job's Pipeline Configuration
getPipelineConfigurationProviders() - Method in GovernanceTier.DescriptorImpl
getPluginDisplayName() - Method in PluginLibraryProvider
getPrimitiveClass() - Method in StepWrapper
getPrimitiveCollector(CpsFlowExecution) - Method in TemplatePrimitiveInjector
getPrimitiveNames() - Method in TemplatePrimitiveCollector
getPrimitives() - Method in LibraryNamespace
getPrimitives() - Method in TemplatePrimitiveCollector
getProp(LinkedHashMap, String) - Method in ConfigValidator
getProperty(String) - Method in ApplicationEnvironment
getProperty(String) - Method in DslEnvVar
getProperty(String) - Method in LibraryNamespace
getProperty(String) - Method in PipelineConfigurationBuilder
getProperty(String) - Method in TemplatePrimitiveCollector.JTEVar
getProperty(String) - Method in TemplatePrimitiveNamespace
getProvideDefaultTemplate() - Method in ConsoleDefaultPipelineTemplate
getProvidePipelineConfig() - Method in ConsolePipelineConfiguration
getSchema() - Method in JteBlockWrapper
getScm() - Method in ScmLibraryProvider
getScm() - Method in ScmPipelineConfigurationProvider
getSCMSourceCriteria(SCMSource) - Method in TemplateBranchProjectFactory
getSCMSourceCriteria(SCMSource) - Method in TemplateMultiBranchProjectFactory
getScript(CpsFlowExecution) - Method in StepWrapper
getScriptPath() - Method in MultibranchTemplateFlowDefinition
getScriptPath() - Method in TemplateMultiBranchProjectFactory
getStageContext() - Method in StepWrapperScript
getStepContext() - Method in StepWrapperScript
getSteps(String) - Method in TemplatePrimitiveCollector
getTemplate(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinition
getTemplate(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinitionConfiguration
getTemplate(FlowExecutionOwner) - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
getTemplate() - Method in ConsoleNamedPipelineTemplate
getTemplate(FlowExecutionOwner, String) - Method in ConsolePipelineConfigurationProvider
getTemplate(FlowExecutionOwner, String) - Method in GovernanceTier
getTemplate(FlowExecutionOwner) - Method in MultibranchTemplateFlowDefinition
getTemplate(FlowExecutionOwner, String) - Method in NullPipelineConfigurationProvider
getTemplate(FlowExecutionOwner, String) - Method in PipelineConfigurationProvider
getTemplate(FlowExecutionOwner) - Method in ScmAdHocTemplateFlowDefinitionConfiguration
getTemplate(FlowExecutionOwner, String) - Method in ScmPipelineConfigurationProvider
getTemplate(FlowExecutionOwner) - Method in TemplateFlowDefinition: Fetch the job's Pipeline Template, if present
getTier() - Method in TemplateConfigFolderProperty
getTier() - Method in TemplateGlobalConfig
getValue(CpsScript, Boolean) - Method in Keyword
getValue(CpsScript) - Method in PipelineConfigVariableInjector.PipelineConfigGlobalVariable
getValue(CpsScript, Boolean) - Method in Stage
getValue(CpsScript, Boolean) - Method in StepWrapper
getValue(CpsScript, Boolean) - Method in TemplatePrimitive
getValue(CpsScript) - Method in TemplatePrimitiveCollector.JTEVar
getValue(CpsScript) - Method in TemplatePrimitiveCollector.StepsVar
getVariable(String) - Method in PipelineConfigurationDsl.DslBinding
GlobalCollisionValidator - Class in org.boozallen.plugins.jte.init.primitives.injectors: checks for collisions between TemplatePrimitives and Jenkins global variables and steps
GovernanceTier - Class in org.boozallen.plugins.jte.init.governance: stores hierarchical configurations for JTE
GovernanceTier.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance
GovernanceTier() - Constructor in GovernanceTier

H

hasConfig(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinitionConfiguration
hasConfig(FlowExecutionOwner) - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
hasConfig(FlowExecutionOwner) - Method in ScmAdHocTemplateFlowDefinitionConfiguration
hasLibrary(FlowExecutionOwner, String) - Method in LibraryProvider: Determines whether the provider has a library
hasLibrary(FlowExecutionOwner, String) - Method in PluginLibraryProvider
hasLibrary(FlowExecutionOwner, String) - Method in ScmLibraryProvider
hasStep(String) - Method in TemplatePrimitiveCollector
hasTemplate(FlowExecutionOwner) - Method in AdHocTemplateFlowDefinitionConfiguration
hasTemplate(FlowExecutionOwner) - Method in ConsoleAdHocTemplateFlowDefinitionConfiguration
hasTemplate(FlowExecutionOwner) - Method in ScmAdHocTemplateFlowDefinitionConfiguration
HookContext - Class in org.boozallen.plugins.jte.init.primitives.hooks: encapsulates the runtime context to inform lifecycle hook annotated library step methods
hookContext - Field in StepWrapper: optional HookContext. assumes nondefault value if this step was invoked because of a lifecycle hook
HookInjector - Class in org.boozallen.plugins.jte.init.primitives.hooks: registers the CpsTransformed classes used during pipeline execution related to lifecycle hook invocation
HooksWrapper - Class in org.boozallen.plugins.jte.init.primitives.hooks: This class is used from {@see PipelineTemplateCompiler} to invoke Lifecycle hooks in template

I

Init - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks: Annotation marking a library step method to potentially execute prior to pipeline template execution
initialize() - Method in PluginLibraryProvider
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in ApplicationEnvironmentInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in DefaultStepInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in HookInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in KeywordInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in LibraryStepInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in PipelineConfigVariableInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in StageInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in TemplateMethodInjector
injectPrimitives(CpsFlowExecution, PipelineConfigurationObject) - Method in TemplatePrimitiveInjector: parse the aggregated pipeline configuration to instantiate a TemplatePrimitive and store it in a TemplatePrimitiveNamespace
invoke(Class<? extends Annotation>, Boolean) - Method in HooksWrapper
isApplicable(Class<? extends MultiBranchProject>) - Method in TemplateBranchProjectFactory.DescriptorDefaultImpl
isDefaultStep - Field in StepWrapper
isLibraryStep - Field in StepWrapper
isOverloaded() - Method in TemplatePrimitive
isTemplateStep - Field in StepWrapper

J

JteBlockValidator - Class in org.boozallen.plugins.jte.init.primitives.injectors: Validates the jte configuration block
JteBlockWrapper - Class in org.boozallen.plugins.jte.init: Represents the jte{} block in the Pipeline Configuration
JTEException - Class in org.boozallen.plugins.jte.util: A generic exception to mark an exception as coming from JTE

K

keepOriginal() - Method in StepAlias: Whether or not to create a step for the original step name
Keyword - Class in org.boozallen.plugins.jte.init.primitives.injectors: JTE primitive that represents a pre-populated variable
KeywordInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: creates Keywords

L

LibraryNamespace - Class in org.boozallen.plugins.jte.init.primitives.injectors: Stores loaded libraries' steps
LibraryProvider - Class in org.boozallen.plugins.jte.init.governance.libs: base class for different mechanisms to load a library
LibraryProvider.LibraryProviderDescriptor - Class in org.boozallen.plugins.jte.init.governance.libs
LibraryProvidingPlugin - Class in org.boozallen.plugins.jte.init.governance.libs: extended by third party plugins that package a set of libraries
LibraryProvidingPlugin.LibraryProvidingPluginDescriptor - Class in org.boozallen.plugins.jte.init.governance.libs
LibrarySource - Class in org.boozallen.plugins.jte.init.governance.libs: generic holder for a LibraryProvider used to fetch libraries from a source
LibrarySource.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.libs
LibrarySource(LibraryProvider) - Constructor in LibrarySource
LibraryStepInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: Loads libraries from the pipeline configuration
loadLibrary(FlowExecutionOwner, String, FilePath, FilePath) - Method in LibraryProvider: Copies the library's src files to the provided directory
loadLibrary(FlowExecutionOwner, String, FilePath, FilePath) - Method in PluginLibraryProvider
loadLibrary(FlowExecutionOwner, String, FilePath, FilePath) - Method in ScmLibraryProvider
LogLevel - Enum in org.boozallen.plugins.jte.util: Different log levels used within the TemplateLogger to change log color

M

methodMissing(String, def) - Method in PipelineConfigurationBuilder
methodMissing(String, Object) - Method in TemplatePrimitiveNamespace
MultibranchTemplateFlowDefinition - Class in org.boozallen.plugins.jte.job: Allows JTE to be used in a MultiBranch Pipeline
MultibranchTemplateFlowDefinition.DescriptorImpl - Class in org.boozallen.plugins.jte.job
MultibranchTemplateFlowDefinition.HideMeElsewhere - Class in org.boozallen.plugins.jte.job

N

newInstance(StaplerRequest, JSONObject) - Method in GovernanceTier.DescriptorImpl
newInstance() - Method in TemplateMultiBranchProjectFactory.DescriptorImpl
Notify - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks: Annotation marking a library step method to potentially execute after other step executions and after the pipeline template execution
NullPipelineConfigurationProvider - Class in org.boozallen.plugins.jte.init.governance.config: A null configuration provider when not defining a pipeline configuration on a GovernanceTier
NullPipelineConfigurationProvider.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config
NullPipelineConfigurationProvider() - Constructor in NullPipelineConfigurationProvider

O

orchestrate(CpsFlowExecution, PipelineConfigurationObject) - Method in TemplatePrimitiveInjector: Triggers the 3-phase initialization process by iterating over all registered injectors
overloaded - Field in TemplatePrimitive: The GlobalCollisionValidator will populate this list with all TemplatePrimitives sharing the same name if there is more than 1.

P

parse(String) - Method in PipelineConfigurationDsl
parseClass(String) - Method in TemplatePrimitiveInjector: Used to compile pipeline primitives using the CPS transformer.
parseSchema(String) - Method in ConfigValidator
parseSource(CpsFlowExecution) - Method in StepWrapper: recompiles the StepWrapperScript if missing.
permits(Class<?>) - Method in TemplatePrimitiveCollector.CustomClassFilterImpl
permitsConstructor(Constructor<?>, Object) - Method in SandboxWhitelist
permitsMethod(Method, Object, Object) - Method in SandboxWhitelist
permitsStaticMethod(Method, Object) - Method in SandboxWhitelist
pickle(StepWrapperScript) - Method in StepWrapperScriptPickle.Pickler
PIPELINE_CONFIG_VAR - Field in PipelineConfigurationBuilder
PipelineConfigurationAggregator - Class in org.boozallen.plugins.jte.init: Fetches the Pipeline Configurations from the Configuration Hierarchy and merges them yielding an Aggregated Pipeline Configuration
PipelineConfigurationAggregator(FlowExecutionOwner) - Constructor in PipelineConfigurationAggregator
PipelineConfigurationBuilder - Class in org.boozallen.plugins.jte.init.governance.config.dsl: Script base class used during execution of the pipeline configuration DSL.
PipelineConfigurationBuilder.BuilderMethod - Enum in org.boozallen.plugins.jte.init.governance.config.dsl
PipelineConfigurationBuilder() - Constructor in PipelineConfigurationBuilder
PipelineConfigurationDsl - Class in org.boozallen.plugins.jte.init.governance.config.dsl: Parses the pipeline configuration DSL into a PipelineConfigurationObject
PipelineConfigurationDsl.ConfigBlockMap - Class in org.boozallen.plugins.jte.init.governance.config.dsl
PipelineConfigurationDsl.ConfigBlockMap(Map) - Constructor in PipelineConfigurationDsl.ConfigBlockMap
PipelineConfigurationDsl.DslBinding - Class in org.boozallen.plugins.jte.init.governance.config.dsl
PipelineConfigurationDsl.DslBinding(PipelineConfigurationObject, DslEnvVar) - Constructor in PipelineConfigurationDsl.DslBinding
PipelineConfigurationDsl(FlowExecutionOwner) - Constructor in PipelineConfigurationDsl
PipelineConfigurationObject - Class in org.boozallen.plugins.jte.init.governance.config.dsl: The parsed representation of a pipeline configuration
PipelineConfigurationObject(FlowExecutionOwner) - Constructor in PipelineConfigurationObject
PipelineConfigurationProvider - Class in org.boozallen.plugins.jte.init.governance.config: abstract base clase defining the interface for different methods to provide a pipeline configuration to a GovernanceTier
PipelineConfigurationProvider.PipelineConfigurationProviderDescriptor - Class in org.boozallen.plugins.jte.init.governance.config
PipelineConfigVariableInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: Exposes the aggregated pipeline configuration as a variable called 'pipelineConfig'
PipelineConfigVariableInjector.PipelineConfigGlobalVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors
PipelineConfigVariableInjector.PipelineConfigGlobalVariable(Map) - Constructor in PipelineConfigVariableInjector.PipelineConfigGlobalVariable
PipelineTemplateCompiler - Class in org.boozallen.plugins.jte.init: Decorates the pipeline template during compilation
PipelineTemplateResolver - Class in org.boozallen.plugins.jte.init: Determines the Pipeline Template for a given Run
PipelineTemplateResolver(FlowExecutionOwner) - Constructor in PipelineTemplateResolver
PluginLibraryProvider - Class in org.boozallen.plugins.jte.init.governance.libs: fetches libraries from a LibraryProvidingPlugin that packages them
PluginLibraryProvider.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.libs
PluginLibraryProvider.FilterImpl - Class in org.boozallen.plugins.jte.init.governance.libs
PluginLibraryProvider(LibraryProvidingPlugin) - Constructor in PluginLibraryProvider
plus(PipelineConfigurationObject) - Method in PipelineConfigurationObject
prefixBaseDir(String) - Method in ScmLibraryProvider
prepareScript(StepWrapper, String) - Method in StepWrapperFactory: Parses source code and turns it into a CPS transformed executable script that's been autowired appropriately for JTE.
print(String, LogLevel) - Method in TemplateLogger
printBlock(List, Integer, Map, ArrayList, PipelineConfigurationObject) - Method in PipelineConfigurationDsl
printError(String) - Method in TemplateLogger
printToConsole(CpsFlowExecution) - Method in AggregateException
printWarning(String) - Method in TemplateLogger
propertyMissing(String) - Method in PipelineConfigurationBuilder

Q

R

readResolve() - Method in AdHocTemplateFlowDefinition
readResolve() - Method in GovernanceTier
readResolve() - Method in MultibranchTemplateFlowDefinition
readResolve() - Method in TemplateBranchProjectFactory
readResolve() - Method in TemplateMultiBranchProjectFactory
recordMergeOrOverride(String) - Method in PipelineConfigurationBuilder
recurseChildren(SCMFile, Closure) - Method in ScmLibraryProvider
rehydrate(FlowExecutionOwner) - Method in StepWrapperScriptPickle
ReservedVariableName - Class in org.boozallen.plugins.jte.init.primitives: Extension point to register particular variable names for protection to prevent TemplatePrimitive's from overriding them
resolve(PipelineConfigurationObject) - Method in PipelineTemplateResolver
resource(String) - Method in StepWrapperScript: Used within steps to access library resources
RESOURCES_DIR_NAME - Field in LibraryProvider: the name of the directory containing library resources
RunAfter - Annotation Type in org.boozallen.plugins.jte.init.primitives
runIfJTE(CpsFlowExecution, Closure) - Method in StepWrapperFactory.StepWrapperShellDecorator

S

SandboxWhitelist - Class in org.boozallen.plugins.jte.util: Whitelists JTE primitives as permitted within the Jenkins pipeline sandbox.
ScmAdHocTemplateFlowDefinitionConfiguration - Class in org.boozallen.plugins.jte.job: Defines a pipeline configuration repository from the Jenkins console.
ScmAdHocTemplateFlowDefinitionConfiguration.DescriptorImpl - Class in org.boozallen.plugins.jte.job
ScmAdHocTemplateFlowDefinitionConfiguration(SCM, String, String) - Constructor in ScmAdHocTemplateFlowDefinitionConfiguration
ScmLibraryProvider - Class in org.boozallen.plugins.jte.init.governance.libs: fetches libraries from a source code repository
ScmLibraryProvider.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.libs
ScmLibraryProvider() - Constructor in ScmLibraryProvider
ScmPipelineConfigurationProvider - Class in org.boozallen.plugins.jte.init.governance.config: Fetches pipeline configuration from a source code repository
ScmPipelineConfigurationProvider.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance.config
ScmPipelineConfigurationProvider() - Constructor in ScmPipelineConfigurationProvider
serialize(PipelineConfigurationObject) - Method in PipelineConfigurationDsl
setBaseDir(String) - Method in ScmLibraryProvider
setBaseDir(String) - Method in ScmPipelineConfigurationProvider
setBuildRootDir(File) - Method in StepWrapperScript
setConfig(LinkedHashMap) - Method in StepWrapperScript
setConfigurationPath(String) - Method in MultibranchTemplateFlowDefinition
setConfigurationPath(String) - Method in TemplateBranchProjectFactory
setConfigurationPath(String) - Method in TemplateMultiBranchProjectFactory
setConfigurationProvider(PipelineConfigurationProvider) - Method in GovernanceTier
setFilterBranches(Boolean) - Method in TemplateBranchProjectFactory
setFilterBranches(Boolean) - Method in TemplateMultiBranchProjectFactory
setHookContext(HookContext) - Method in StepWrapper
setHookContext(HookContext) - Method in StepWrapperScript
setLibrarySources(List<LibrarySource>) - Method in GovernanceTier
setMergeToTrue() - Method in PipelineConfigurationBuilder
setMessage(String) - Method in AggregateException
setName(String) - Method in ConsoleNamedPipelineTemplate
setOverloaded(List<TemplatePrimitive>) - Method in TemplatePrimitive
setOverrideToTrue() - Method in PipelineConfigurationBuilder
setParent(TemplatePrimitiveNamespace) - Method in TemplatePrimitiveNamespace
setProperty(String, Object) - Method in ApplicationEnvironment
setProperty(String, Object) - Method in PipelineConfigurationBuilder
setResourcesPath(String) - Method in StepWrapperScript
setScm(SCM) - Method in ScmLibraryProvider
setScm(SCM) - Method in ScmPipelineConfigurationProvider
setScriptPath(String) - Method in MultibranchTemplateFlowDefinition
setScriptPath(String) - Method in TemplateMultiBranchProjectFactory
setStageContext(StageContext) - Method in StepWrapper
setStageContext(StageContext) - Method in StepWrapperScript
setStepContext(StepContext) - Method in StepWrapper
setStepContext(StepContext) - Method in StepWrapperScript
setTemplate(String) - Method in ConsoleNamedPipelineTemplate
setTier(GovernanceTier) - Method in TemplateGlobalConfig
setVariable(String, Object) - Method in TemplateBinding
size() - Method in AggregateException
sourceFile - Field in StepWrapper: The FilePath where the source text for this library step can be found
sourceText - Field in StepWrapper: Alternatively, store the source text in a variable.
SRC_DIR_NAME - Field in LibraryProvider: the name of the directory containing library src files
Stage - Class in org.boozallen.plugins.jte.init.primitives.injectors: represents a group of library steps to be called.
Stage(String, ArrayList<String>) - Constructor in Stage
stageContext - Field in StepWrapper: optional StageContext. assumes nondefault value of this step is running as part of a Stage
StageInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: creates Stages
StageInjector.StageContext - Class in org.boozallen.plugins.jte.init.primitives.injectors
StepAlias - Annotation Type in org.boozallen.plugins.jte.init.primitives.injectors: For use in steps to register step aliases
StepContext - Class in org.boozallen.plugins.jte.init.primitives.injectors: Step metadata
stepContext - Field in StepWrapper: current step's metadata
STEPS_DIR_NAME - Field in LibraryProvider: the name of the directory containing step files
StepWrapper - Class in org.boozallen.plugins.jte.init.primitives.injectors: A library step
StepWrapperFactory - Class in org.boozallen.plugins.jte.init.primitives.injectors: Produces StepWrappers
StepWrapperFactory.StepWrapperShellDecorator - Class in org.boozallen.plugins.jte.init.primitives.injectors: Registers a compiler customization for parsing StepWrappers
StepWrapperFactory(CpsFlowExecution) - Constructor in StepWrapperFactory
StepWrapperScript - Class in org.boozallen.plugins.jte.init.primitives.injectors: The base script used during step execution
StepWrapperScript.ConfigReservedVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors: reserves the config var from being overridden in the binding
StepWrapperScript.HookContextReservedVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors: reserves the config var from being overridden in the binding
StepWrapperScript.ResourceReservedVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors: reserves the config var from being overridden in the binding
StepWrapperScript.StageContextReservedVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors: reserves the config var from being overridden in the binding
StepWrapperScript.StepContextReservedVariable - Class in org.boozallen.plugins.jte.init.primitives.injectors: reserves the config var from being overridden in the binding
StepWrapperScript() - Constructor in StepWrapperScript
StepWrapperScriptPickle - Class in org.boozallen.plugins.jte.init.primitives.injectors: responsible for rehydrating compiled steps required to successfully resume a pipeline that restarts mid-step execution
StepWrapperScriptPickle.Pickler - Class in org.boozallen.plugins.jte.init.primitives.injectors

T

TemplateBinding - Class in org.boozallen.plugins.jte.init.primitives: A custom binding that prevents users from inadvertently overriding TemplatePrimitives or ReservedVariables
TemplateBranchProjectFactory - Class in org.boozallen.plugins.jte.job: Registers MultibranchTemplateFlowDefinition as an option for use with Multibranch Projects
TemplateBranchProjectFactory.DescriptorDefaultImpl - Class in org.boozallen.plugins.jte.job
TemplateBranchProjectFactory() - Constructor in TemplateBranchProjectFactory
TemplateConfigException - Class in org.boozallen.plugins.jte.init.governance.config.dsl: thrown when there's an issue during pipeline configuration parsing
TemplateConfigFolderProperty - Class in org.boozallen.plugins.jte.init.governance: stores a GovernanceTier on Folders in Jenkins
TemplateConfigFolderProperty.DescriptorImpl - Class in org.boozallen.plugins.jte.init.governance
TemplateConfigFolderProperty(GovernanceTier) - Constructor in TemplateConfigFolderProperty
TemplateException - Class in org.boozallen.plugins.jte.init.primitives: An exception
TemplateFlowDefinition - Class in org.boozallen.plugins.jte.job: Defines a JTE Pipeline.
TemplateGlobalConfig - Class in org.boozallen.plugins.jte.init.governance: Stores a GovernanceTier for the entire Jenkins instance
TemplateGlobalConfig() - Constructor in TemplateGlobalConfig
TemplateLogger - Class in org.boozallen.plugins.jte.util: A utility for logging to a run's console output.
TemplateLogger.Annotator - Class in org.boozallen.plugins.jte.util
TemplateLogger.Annotator.DescriptorImpl - Class in org.boozallen.plugins.jte.util
TemplateLogger(TaskListener) - Constructor in TemplateLogger
TemplateMethodInjector - Class in org.boozallen.plugins.jte.init.primitives.injectors: creates no-op steps based on the pipeline configuration
TemplateMultiBranchProjectFactory - Class in org.boozallen.plugins.jte.job: registers MultibranchTemplateFlowDefinition as an option for Organization jobs
TemplateMultiBranchProjectFactory.DescriptorImpl - Class in org.boozallen.plugins.jte.job
TemplateMultiBranchProjectFactory.PerFolderAdder - Class in org.boozallen.plugins.jte.job
TemplateMultiBranchProjectFactory() - Constructor in TemplateMultiBranchProjectFactory
TemplatePrimitive - Class in org.boozallen.plugins.jte.init.primitives: Framework constructs that make templates easier to write.
TemplatePrimitiveCollector - Class in org.boozallen.plugins.jte.init.primitives: Stores {@see TemplatePrimitive}s that have been created for a run
TemplatePrimitiveCollector.CopyTemplatePrimitiveCollector - Class in org.boozallen.plugins.jte.init.primitives: For replayed or restarted jobs, need to copy over the original Run's TemplatePrimitiveCollector to skip initialization but preserve primitives
TemplatePrimitiveCollector.CustomClassFilterImpl - Class in org.boozallen.plugins.jte.init.primitives: Allows TemplatePrimitives to be stored on this action without triggering an Unmarshalling exception.
TemplatePrimitiveCollector.JTEVar - Class in org.boozallen.plugins.jte.init.primitives
TemplatePrimitiveCollector.StepsVar - Class in org.boozallen.plugins.jte.init.primitives
TemplatePrimitiveCollector.TemplatePrimitiveProvider - Class in org.boozallen.plugins.jte.init.primitives: exposes the primitives populated on this action to the Run
TemplatePrimitiveInjector - Class in org.boozallen.plugins.jte.init.primitives: Extension to hook into the initialization process to parse the pipeline configuration, create TemplatePrimitives, and validate them after creation
TemplatePrimitiveNamespace - Class in org.boozallen.plugins.jte.init.primitives: Stores a collection of TemplatePrimitives
toString() - Method in ApplicationEnvironment
toString() - Method in Keyword
toString() - Method in Stage
toString() - Method in StepWrapper
type() - Method in TemplateMultiBranchProjectFactory.PerFolderAdder

U

updateExistingProject(MultiBranchProject<?, ?>, Map<String, Object>, TaskListener) - Method in TemplateMultiBranchProjectFactory

V

Validate - Annotation Type in org.boozallen.plugins.jte.init.primitives.hooks: Annotation marking a library step method to potentially execute prior to pipeline template execution
validate(LinkedHashMap, LinkedHashMap) - Method in ConfigValidator
validateConfiguration(CpsFlowExecution, PipelineConfigurationObject) - Method in ApplicationEnvironmentInjector
validateConfiguration(CpsFlowExecution, PipelineConfigurationObject) - Method in JteBlockValidator
validateConfiguration(CpsFlowExecution, PipelineConfigurationObject) - Method in LibraryStepInjector
validateConfiguration(CpsFlowExecution, PipelineConfigurationObject) - Method in TemplatePrimitiveInjector: Used to validate the pipeline configuration is structurally correct
validatePrimitives(CpsFlowExecution, PipelineConfigurationObject, TemplatePrimitiveCollector) - Method in GlobalCollisionValidator
validatePrimitives(CpsFlowExecution, PipelineConfigurationObject, TemplatePrimitiveCollector) - Method in StageInjector
validatePrimitives(CpsFlowExecution, PipelineConfigurationObject, TemplatePrimitiveCollector) - Method in TemplatePrimitiveInjector: A second pass allowing the different injector's to inspect what TemplatePrimitives have been created and respond accordingly
validateType(TemplateLogger, def, def) - Method in ConfigValidator: returns true if validateType finds an issue
value() - Method in AfterStep: @default true }
value() - Method in BeforeStep: @default true }
value() - Method in CleanUp: @default true }
value() - Method in Init: @default true }
value() - Method in Notify: @default true }
value() - Method in RunAfter
value() - Method in StepAlias: List of static step aliases
value() - Method in Validate: @default true }

W

X

Y

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

Groovy Documentation