jp.ikedam.jenkins.plugins.jobcopy_builder

Class JobcopyOperation

java.lang.Object

hudson.model.AbstractDescribableImpl<JobcopyOperation>

jp.ikedam.jenkins.plugins.jobcopy_builder.JobcopyOperation

All Implemented Interfaces:

ExtensionPoint, Describable<JobcopyOperation>

Direct Known Subclasses:

AbstractXmlJobcopyOperation

public abstract class JobcopyOperation
extends AbstractDescribableImpl<JobcopyOperation>
implements ExtensionPoint

Additional operations performed when the jobcopy build step copies a job. A new additional operation can be defined in following steps:

1. Define a new class derived from JobcopyOperation. AbstractXmlJobcopyOperation is also available.
2. Override perform(String, String, EnvVars, PrintStream) or AbstractXmlJobcopyOperation.perform(org.w3c.dom.Document, EnvVars, PrintStream)
3. Define the internal public static class named DescriptorImpl, derived from Descriptor<JobcopyOperation>
4. annotate the DescriptorImpl with Extension

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
JobcopyOperation()

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<JobcopyOperation,Descriptor<JobcopyOperation>>	all() Return all the available JobcopyOperation whose DescriptorImpl annotated with Extension.
abstract String	perform(String xmlString, String encoding, EnvVars env, PrintStream logger) Return modified XML string of the job configuration.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

JobcopyOperation

public JobcopyOperation()

Method Detail

all

public static DescriptorExtensionList<JobcopyOperation,Descriptor<JobcopyOperation>> all()

Return all the available JobcopyOperation whose DescriptorImpl annotated with Extension.

Returns:

a list of JobcopyOperation

perform

public abstract String perform(String xmlString,
                               String encoding,
                               EnvVars env,
                               PrintStream logger)

Return modified XML string of the job configuration.

Parameters:

xmlString - the XML string of the job to be copied (job/NAME/config.xml)

encoding - the encoding of the XML.

env - Variables defined in the build.

logger - The output stream to log.

Returns:

modified XML string. Return null if an error occurs.