org.jenkinsci.plugins.recipe

Class Ingredient

java.lang.Object

hudson.model.AbstractDescribableImpl<Ingredient>

org.jenkinsci.plugins.recipe.Ingredient

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<Ingredient>

Direct Known Subclasses:

JobIngredient, Parameter, PluginIngredient, ViewIngredient

public abstract class Ingredient
extends hudson.model.AbstractDescribableImpl<Ingredient>
implements hudson.ExtensionPoint

An unit of a configured item in Jenkins that gets transported to another Jenkins instance. Recipe is a collection of Ingredients.

Author:

Kohsuke Kawaguchi

See Also:

Recipe

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
Ingredient()

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject opt) Apply the import options to this ingredient (such as parameter values, variable names, etc.) This is a destructive operation.
protected abstract void	cook(Recipe recipe, ImportReportList reportList) Imports this ingredient into the current Jenkins.
IngredientDescriptor	getDescriptor()
boolean	isVisibleDuringImport() Return false if this recipe needs to be hidden during the import conversation.
protected static InputStream	read(jenkins.util.xstream.XStreamDOM dom)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ingredient

public Ingredient()

Method Detail

getDescriptor

public IngredientDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<Ingredient>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<Ingredient>

isVisibleDuringImport

public boolean isVisibleDuringImport()

Return false if this recipe needs to be hidden during the import conversation.

apply

public void apply(org.kohsuke.stapler.StaplerRequest req,
         net.sf.json.JSONObject opt)

Apply the import options to this ingredient (such as parameter values, variable names, etc.) This is a destructive operation.

cook

protected abstract void cook(Recipe recipe,
        ImportReportList reportList)
                      throws IOException,
                             InterruptedException

Imports this ingredient into the current Jenkins.

Parameters:

recipe -

reportList - Report what was actually done by adding ImportReport to this (both success and non-fatal failures.)

Throws:

IOException

InterruptedException

read

protected static InputStream read(jenkins.util.xstream.XStreamDOM dom)