LibraryProvider (templating-engine-plugin 2.5.5 API)

org.boozallen.plugins.jte.init.governance.libs.LibraryProvider

base class for different mechanisms to load a library

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`LibraryProvider.LibraryProviderDescriptor`

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`CONFIG_FILE`	the library configuration file path
`static java.lang.String`	`RESOURCES_DIR_NAME`	the name of the directory containing library resources
`static java.lang.String`	`SRC_DIR_NAME`	the name of the directory containing library src files
`static java.lang.String`	`STEPS_DIR_NAME`	the name of the directory containing step files

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getLibrarySchema(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)` Returns the contents of the library configuration file, if present.
	`java.lang.Boolean`	`hasLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)` Determines whether the provider has a library
	`void`	`loadLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName, hudson.FilePath srcDir, hudson.FilePath libDir)` Copies the library's src files to the provided directory

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class hudson.model.AbstractDescribableImpl`	hudson.model.AbstractDescribableImpl#getDescriptor(), hudson.model.AbstractDescribableImpl#wait(long), hudson.model.AbstractDescribableImpl#wait(long, int), hudson.model.AbstractDescribableImpl#wait(), hudson.model.AbstractDescribableImpl#equals(java.lang.Object), hudson.model.AbstractDescribableImpl#toString(), hudson.model.AbstractDescribableImpl#hashCode(), hudson.model.AbstractDescribableImpl#getClass(), hudson.model.AbstractDescribableImpl#notify(), hudson.model.AbstractDescribableImpl#notifyAll()
`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()`

- Field Detail
  - public static final java.lang.String CONFIG_FILE
    
    the library configuration file path
  - public static final java.lang.String RESOURCES_DIR_NAME
    
    the name of the directory containing library resources
  - public static final java.lang.String SRC_DIR_NAME
    
    the name of the directory containing library src files
  - public static final java.lang.String STEPS_DIR_NAME
    
    the name of the directory containing step files
- Method Detail
  - java.lang.String getLibrarySchema(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)
    
    Returns the contents of the library configuration file, if present. Null otherwise
    Parameters:
    flowOwner - the Run's FlowExecutionOwner
    libName - the Library to load
    Returns:
    the contents of the library configuration file, if present. null otherwise.
  - java.lang.Boolean hasLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)
    
    Determines whether the provider has a library
    Parameters:
    flowOwner - the Run's FlowExecutionOwner
    libName - the Library to load
    Returns:
    true if the provider has the library
  - void loadLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName, hudson.FilePath srcDir, hudson.FilePath libDir)
    
    Copies the library's src files to the provided directory
    Parameters:
    flowOwner - the Run's FlowExecutionOwner
    libName - the library to load
    srcDir - the directory to copy src files to
    libDir - the directory to copy library setps to

Summary:
Nested
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Groovy] Class LibraryProvider

Nested Class Summary

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String CONFIG_FILE

public static final java.lang.String RESOURCES_DIR_NAME

public static final java.lang.String SRC_DIR_NAME

public static final java.lang.String STEPS_DIR_NAME

Method Detail

java.lang.String getLibrarySchema(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)

java.lang.Boolean hasLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName)

void loadLibrary(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner flowOwner, java.lang.String libName, hudson.FilePath srcDir, hudson.FilePath libDir)