Index (plugin 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

AbstractDslTask - Class in com.here.gradle.plugins.jobdsl.tasks: Shared code for all tasks of the plugin that call an implementation of AbstractTaskRunner to perform the action in another process.
AbstractDslTask() - Constructor in AbstractDslTask
AbstractTaskRunner - Class in com.here.gradle.plugins.jobdsl.tasks.runners: Common code for all tasks that extend AbstractDslTask to perform their actions in another process.
addDsl(Closure) - Method in JobBuilder: Add a DSL closure to the list of closures that will be used to create the job.
addFreeStyleDsl(Closure) - Method in JobBuilder: Convenience method to get full IDE support when adding a DSL closure for a @{link FreeStyleJob}.
addJob(PipelineJobBuilder) - Method in PipelineBuilder
addMatrixDsl(Closure) - Method in JobBuilder: Convenience method to get full IDE support when adding a DSL closure for a @{link MatrixJob}.
addMavenDsl(Closure) - Method in JobBuilder: Convenience method to get full IDE support when adding a DSL closure for a @{link MavenJob}.
addMultiDsl(Closure) - Method in JobBuilder: Convenience method to get full IDE support when adding a DSL closure for a @{link MultiJob}.
addPipelineDsl(Closure) - Method in JobBuilder: Convenience method to get full IDE support when adding a DSL closure for a @{link WorkflowJob}.
allFolders() - Method in PipelineJobBuilder
apply(Project) - Method in JobDslPlugin
applyChanges() - Method in DeferredJobManagement
applyChanges() - Method in RestJobManagement

B

baseFolders(List<String>) - Method in PipelineBuilder
build(Closure) - Method in JobBuilder: Create the job object using the configured DSL closures and job class.
build() - Method in PipelineBuilder
buildDirectory(String) - Method in AbstractDslTask

C

callExtension(String, Item, Class<? extends ExtensibleContext>, Object) - Method in RestJobManagement
checkJobClassNull() - Method in JobBuilder
checkNameIsValid() - Method in JobBuilder
commonDsl(Closure) - Method in PipelineBuilder
compare(String, String) - Method in PathComparator
concatenateDslClosures(Closure) - Method in JobBuilder: Concatenate all dslClosures to a single Closure.
createItem(Item) - Method in RestJobManagement
createItemPath(String) - Method in FolderPathHelper: Get the path to the create REST method for an item name.
createJobManagement(Jenkins, ItemFilter) - Method in AbstractTaskRunner
createJobManagement(Jenkins, ItemFilter) - Method in GenerateXmlRunner
createJobManagement(Jenkins, ItemFilter) - Method in UpdateJenkinsRunner
createOrUpdateConfig(Item, boolean) - Method in FilteringJenkinsJobManagement
createOrUpdateConfig(Item, boolean) - Method in RestJobManagement
createOrUpdateUserContent(UserContent, boolean) - Method in RestJobManagement
createOrUpdateView(String, String, boolean) - Method in FilteringJenkinsJobManagement
createOrUpdateView(String, String, boolean) - Method in RestJobManagement
createView(String, String) - Method in RestJobManagement
createViewPath(String) - Method in FolderPathHelper: Get the path to the create REST method for a view name.

D

defaultConfiguration(Map<String, Object>) - Method in PipelineBuilder
DeferredJobManagement - Interface in com.here.gradle.plugins.jobdsl: Interface for an implementation of javaposse.jobdsl.dsl.JobManagement that does not apply the changes immediately but stores them for later execution.
DslConfig - Class in com.here.gradle.plugins.jobdsl.util: This class holds the global and server specific configuration maps.

E

exec() - Method in AbstractDslTask
EXIT_EXCEPTION - Field in AbstractTaskRunner
EXIT_FAILURE - Field in AbstractTaskRunner
EXIT_SUCCESS - Field in AbstractTaskRunner

F

filter - Field in AbstractDslTask
FilteringJenkinsJobManagement - Class in com.here.gradle.plugins.jobdsl: Extends javaposse.jobdsl.plugin.JenkinsJobManagement to add support for an ItemFilter.
FilteringJenkinsJobManagement(ItemFilter, PrintStream, Map<String, ?>, File, boolean) - Constructor in FilteringJenkinsJobManagement
findParentItem(Jenkins, String) - Method in GenerateXmlRunner
findPlugin(String) - Method in RestJobManagement
FolderPathHelper - Class in com.here.gradle.plugins.jobdsl: Static helper methods for URL paths to items in folders.
freeStyleJob(Closure) - Method in JobBuilder: Set the job type to javaposse.jobdsl.dsl.jobs.FreeStyleJob and add the provided DSL closure to the list of closures.
fullJobName() - Method in JobBuilder: Return the full job name including folders.
fullJobName() - Method in PipelineJobBuilder

G

GenerateXmlRunner - Class in com.here.gradle.plugins.jobdsl.tasks.runners: Performs the action of the GenerateXmlTask to generate XML files for all items and views.
GenerateXmlTask - Class in com.here.gradle.plugins.jobdsl.tasks: Task that calls GenerateXmlRunner to generate XML files for all items and views configured in the project.
GenerateXmlTask() - Constructor in GenerateXmlTask
get(String) - Method in DslConfig: Get a value from the configuration map.
getConfig(String) - Method in RestJobManagement
getItemType(Item) - Method in RestJobManagement
getMainClass() - Method in AbstractDslTask
getMainClass() - Method in GenerateXmlTask
getMainClass() - Method in UpdateJenkinsTask
getParameters() - Method in RestJobManagement
getPermissions(String) - Method in RestJobManagement
getPluginVersion(String) - Method in RestJobManagement
getProperties() - Method in AbstractDslTask
getProperties() - Method in GenerateXmlTask
getProperties() - Method in UpdateJenkinsTask
getVSphereCloudHash(String) - Method in RestJobManagement
GradleJobDslPluginException - Class in com.here.gradle.plugins.jobdsl: java.lang.RuntimeException used for plugin specific exceptions.
GradleJobDslPluginException(String, Throwable) - Constructor in GradleJobDslPluginException
GroovySeedJobBuilder - Class in com.here.gradle.plugins.jobdsl.util: A JobBuilder that creates a seed job that runs the dslGenerateXml Gradle task to create the XML files and then uses a system groovy script build step to update the jobs.
GroovySeedJobBuilder(DslFactory) - Constructor in GroovySeedJobBuilder

H

I

isMinimumCoreVersion(String) - Method in RestJobManagement
isMinimumPluginVersionInstalled(String, String) - Method in RestJobManagement
itemConfigPath(String) - Method in FolderPathHelper: Generate the path to the config.xml for an item.
ItemFilter - Class in com.here.gradle.plugins.jobdsl: Utility class to check if item names match a regular expression.
ItemFilter(String) - Constructor in ItemFilter
itemNameToPath(String) - Method in FolderPathHelper: Generate the path to the item by injecting 'job/' between the parent folder names.

J

JobBuilder - Class in com.here.gradle.plugins.jobdsl.util: This is the base class for all job builders.
JobBuilder(DslFactory) - Constructor in JobBuilder
JobDslPlugin - Class in com.here.gradle.plugins.jobdsl: Gradle plugin configuration for the Job DSL plugin.
JobDslPluginExtension - Class in com.here.gradle.plugins.jobdsl: The configuration extension for the Job DSL plugin.
JobDslPluginExtension(Project) - Constructor in JobDslPluginExtension
jobManagement - Field in AbstractTaskRunner

K

L

logPluginDeprecationWarning(String, String) - Method in RestJobManagement

M

main(String) - Method in GenerateXmlRunner
main(String) - Method in UpdateJenkinsRunner
matches(String) - Method in ItemFilter: Check if the itemName matches the filter pattern.
matrixJob(Closure) - Method in JobBuilder: Set the job type to javaposse.jobdsl.dsl.jobs.MatrixJob and add the provided DSL closure to the list of closures.
mavenJob(Closure) - Method in JobBuilder: Set the job type to javaposse.jobdsl.dsl.jobs.MavenJob and add the provided DSL closure to the list of closures.
multiJob(Closure) - Method in JobBuilder: Set the job type to javaposse.jobdsl.dsl.jobs.MultiJob and add the provided DSL closure to the list of closures.

N

nameWithoutFolders(String) - Method in GenerateXmlRunner

O

P

PathComparator - Class in com.here.gradle.plugins.jobdsl.util: A comparator that orders path names.
performCreateOrUpdateConfig(Item, boolean) - Method in RestJobManagement
performCreateOrUpdateView(String, String, boolean) - Method in RestJobManagement
PipelineBuilder - Class in com.here.gradle.plugins.jobdsl.util: Class to manage a list of jobs that share some configuration.
pipelineJob(Closure) - Method in JobBuilder: Set the job type to javaposse.jobdsl.dsl.jobs.WorkflowJob and add the provided DSL closure to the list of closures.
PipelineJobBuilder - Class in com.here.gradle.plugins.jobdsl.util: Implementation of JobBuilder that can be used with a PipelineBuilder.
PipelineJobBuilder(DslFactory) - Constructor in PipelineJobBuilder
postProcess(Jenkins, List<GeneratedItems>, ItemFilter) - Method in AbstractTaskRunner
postProcess(Jenkins, List<GeneratedItems>, ItemFilter) - Method in GenerateXmlRunner
postProcess(Jenkins, List<GeneratedItems>, ItemFilter) - Method in UpdateJenkinsRunner

Q

queueJob(String) - Method in RestJobManagement

R

readFileInWorkspace(String, String) - Method in RestJobManagement
removeFoldersFromName(String) - Method in FolderPathHelper: Remove all folders from the name.
renameJobMatching(String, String) - Method in RestJobManagement
requestExistingItemXml(Item) - Method in RestJobManagement
requestExistingViewXml(String) - Method in RestJobManagement
requestJenkinsVersion() - Method in RestJobManagement
requestPlugins() - Method in RestJobManagement
requireMinimumCoreVersion(String) - Method in RestJobManagement
requireMinimumPluginVersion(String, String, boolean) - Method in RestJobManagement
requirePlugin(String, boolean) - Method in RestJobManagement
restApiPathForName(String) - Method in FolderPathHelper: Get the base path of the REST api for the provided name.
RestJobManagement - Class in com.here.gradle.plugins.jobdsl: Implementation of javaposse.jobdsl.dsl.JobManagement that performs all actions using the REST API of Jenkins.
RestJobManagement.ItemRequest - Class in com.here.gradle.plugins.jobdsl
RestJobManagement.ViewRequest - Class in com.here.gradle.plugins.jobdsl
RestJobManagement(ItemFilter, boolean, boolean, String, String, String, Jenkins) - Constructor in RestJobManagement
restMethodPathForName(String, String) - Method in FolderPathHelper: Get the path to the provided REST method for the name.
run() - Method in AbstractTaskRunner
runProperties - Field in AbstractTaskRunner

S

server - Field in AbstractDslTask
ServerDefinition - Class in com.here.gradle.plugins.jobdsl: Class holding the configuration for a Jenkins server.
ServerDefinition(String) - Constructor in ServerDefinition
serverName - Field in AbstractDslTask
servers(Closure) - Method in JobDslPluginExtension
setConfiguration(Map<String, ?>) - Method in DslConfig
setDisablePluginChecks(boolean) - Method in UpdateJenkinsTask
setDryRun(boolean) - Method in UpdateJenkinsTask
setFailOnMissingPlugin(boolean) - Method in GenerateXmlTask
setFilter(String) - Method in AbstractDslTask
setJenkinsApiToken(String) - Method in UpdateJenkinsTask
setJenkinsUrl(String) - Method in UpdateJenkinsTask
setJenkinsUser(String) - Method in UpdateJenkinsTask
setServerConfiguration(Map<String, ?>) - Method in DslConfig
setServerName(String) - Method in AbstractDslTask
STATUS_COULD_NOT_CREATE - Field in RestJobManagement
STATUS_COULD_NOT_UPDATE - Field in RestJobManagement
STATUS_CREATED - Field in RestJobManagement
STATUS_IGNORED - Field in RestJobManagement
STATUS_UP_TO_DATE - Field in RestJobManagement
STATUS_UPDATED - Field in RestJobManagement
STATUS_WOULD_BE_CREATED - Field in RestJobManagement
STATUS_WOULD_BE_UPDATED - Field in RestJobManagement
streamFileInWorkspace(String) - Method in RestJobManagement

T

U

updateItem(Item, String) - Method in RestJobManagement
UpdateJenkinsRunner - Class in com.here.gradle.plugins.jobdsl.tasks.runners: Performs the action of the UpdateJenkinsTask to upload all items and views to a Jenkins instance using the REST API.
UpdateJenkinsTask - Class in com.here.gradle.plugins.jobdsl.tasks: Task that calls UpdateJenkinsRunner to upload all items and views configured in the project to a Jenkins instance using the REST API.
UpdateJenkinsTask() - Constructor in UpdateJenkinsTask
updateView(String, String) - Method in RestJobManagement

V

viewConfigPath(String) - Method in FolderPathHelper: Generate the path to the config.xml for a view.
viewNameToPath(String) - Method in FolderPathHelper: Generate the path to the view by injecting 'job/' between the parent folder names and 'view/' before the view name.