org.jenkinsci.plugins.koji

Class KojiBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.koji.KojiBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class KojiBuilder
extends hudson.tasks.Builder

KojiBuilder is the main extension point for Koji integration with Jenkins.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new KojiBuilder is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields (like kojiBuild) to remember the configuration.

When a build is performed, the perform(AbstractBuild, Launcher, BuildListener) method will be invoked.

Author:

Vaclav Tunka

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KojiBuilder.DescriptorImpl Descriptor for KojiBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
KojiBuilder(String kojiBuild, String kojiTarget, String kojiPackage, String kojiOptions, String kojiTask, boolean kojiScratchBuild, String kojiScmUrl) Currently all fields are persisted in single constructor when user submits project configuration form.

Method Summary

Modifier and Type	Method and Description
KojiBuilder.DescriptorImpl	getDescriptor() Gets the descriptor for this BuildStep.
String	getKojiBuild()
String	getKojiOptions()
String	getKojiPackage()
String	getKojiScmUrl()
String	getKojiTarget()
String	getKojiTask()
boolean	isKojiScratchBuild()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Main method for plugin execution containing all logic for BuildStep.
void	setKojiScratchBuild(boolean kojiScratchBuild)

Methods inherited from class hudson.tasks.Builder

all, 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

KojiBuilder

@DataBoundConstructor
public KojiBuilder(String kojiBuild,
                                         String kojiTarget,
                                         String kojiPackage,
                                         String kojiOptions,
                                         String kojiTask,
                                         boolean kojiScratchBuild,
                                         String kojiScmUrl)

Currently all fields are persisted in single constructor when user submits project configuration form.

Parameters:

kojiBuild -

kojiTarget -

kojiPackage -

kojiOptions -

kojiTask -

kojiScratchBuild -

kojiScmUrl -

Method Detail

getKojiBuild

public String getKojiBuild()

getKojiTarget

public String getKojiTarget()

getKojiPackage

public String getKojiPackage()

getKojiOptions

public String getKojiOptions()

getKojiTask

public String getKojiTask()

isKojiScratchBuild

public boolean isKojiScratchBuild()

setKojiScratchBuild

public void setKojiScratchBuild(boolean kojiScratchBuild)

getKojiScmUrl

public String getKojiScmUrl()

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

Main method for plugin execution containing all logic for BuildStep. At first init method is called providing initialization to XML-RPC and Koji-CLI integration. User selected Koji task then gets executed.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

getDescriptor

public KojiBuilder.DescriptorImpl getDescriptor()

Gets the descriptor for this BuildStep.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder

Returns: