jp.ikedam.jenkins.plugins.jobcopy_builder

Class JobcopyBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

public class JobcopyBuilder
extends Builder

A build step to copy a job. You can specify additional operations that is performed when copying, and the operations can be extended with plugins using Extension Points.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobcopyBuilder.DescriptorImpl The internal class to work with views.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
JobcopyBuilder(String fromJobName, String toJobName, boolean overwrite, List<JobcopyOperation> jobcopyOperationList, List<AdditionalFileset> additionalFilesetList) Constructor to instantiate from parameters in the job configuration page.

Method Summary

Modifier and Type	Method and Description
List<AdditionalFileset>	getAdditionalFilesetList() Retuns a list of sets of files to copy additional to JOBNAME/config.xml.
String	getFromJobName() Returns the name of job to be copied from.
List<JobcopyOperation>	getJobcopyOperationList() Returns the list of operations.
static <T> T	getRelative(String pathName, ItemGroup<?> context, Class<T> klass) Reimplementation of Jenkins.getItem(String, ItemGroup, Class) Existing implementation has following problems: * Falls back to Jenkins.getItemByFullName(String) * Cannot get ItemGroup
String	getToJobName() Returns the name of job to be copied to.
boolean	isOverwrite() Returns whether to overwrite an existing job.
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobcopyBuilder

@DataBoundConstructor
public JobcopyBuilder(String fromJobName,
                                            String toJobName,
                                            boolean overwrite,
                                            List<JobcopyOperation> jobcopyOperationList,
                                            List<AdditionalFileset> additionalFilesetList)

Constructor to instantiate from parameters in the job configuration page. When instantiating from the saved configuration, the object is directly serialized with XStream, and no constructor is used.

Parameters:

fromJobName - a name of a job to be copied from. may contains variable expressions.

toJobName - a name of a job to be copied to. may contains variable expressions.

overwrite - whether to overwrite if the job to be copied to is already existing.

jobcopyOperationList - the list of operations to be performed when copying.

additionalFilesetList - the list of sets of files to copy additional to JOBNAME/config.xml.

Method Detail

getFromJobName

public String getFromJobName()

Returns the name of job to be copied from. Variable expressions will be expanded.

Returns:

the name of job to be copied from

getToJobName

public String getToJobName()

Returns the name of job to be copied to. Variable expressions will be expanded.

Returns:

the name of job to be copied to

isOverwrite

public boolean isOverwrite()

Returns whether to overwrite an existing job. If the copied-to job is already exists, jobcopy build step works as following depending on this value.

How jobcopy build step works with isOverwrite

isOverwrite	behavior
true	Overwrite the configuration of the existing job.
false	Build fails.

Returns:

whether to overwrite an existing job.

getJobcopyOperationList

public List<JobcopyOperation> getJobcopyOperationList()

Returns the list of operations.

Returns:

the list of operations

getAdditionalFilesetList

public List<AdditionalFileset> getAdditionalFilesetList()

Retuns a list of sets of files to copy additional to JOBNAME/config.xml.

Returns:

the additionalFilesetList

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)
                throws IOException,
                       InterruptedException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

IOException

InterruptedException

getRelative

public static <T> T getRelative(String pathName,
                                ItemGroup<?> context,
                                Class<T> klass)

Reimplementation of Jenkins.getItem(String, ItemGroup, Class) Existing implementation has following problems: * Falls back to Jenkins.getItemByFullName(String) * Cannot get ItemGroup

Type Parameters:

T - class of the item to retrieve

Parameters:

pathName - relative path to an item to retrieve

context - context to calculate pathName from.

klass - class of the item to retrieve

Returns:

an item