org.jenkinsci.plugins.recipe

Class Recipe

java.lang.Object

hudson.model.AbstractDescribableImpl<Recipe>

org.jenkinsci.plugins.recipe.Recipe

All Implemented Interfaces:

hudson.model.Describable<Recipe>, org.kohsuke.stapler.HttpResponse

public class Recipe
extends hudson.model.AbstractDescribableImpl<Recipe>
implements org.kohsuke.stapler.HttpResponse

Group of Ingredients that represent a set of configured stuff in Jenkins that gets transported from one Jenkins to another, for example for one person to share how he set up something to other people.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Recipe.DescriptorImpl
class	Recipe.ImportOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION Common file extension for Jenkins recipe.
static Pattern	ID_PATTERN
static hudson.util.XStream2	XSTREAM

Constructor Summary

Constructors

Constructor and Description
Recipe(String id, String version, String displayName, String description, List<? extends Ingredient> ingredients)

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(org.kohsuke.stapler.StaplerRequest req)
void	cook(ImportReportList reportList) Imports this ingredient into the current Jenkins.
Recipe.ImportOptions	createImportOptions()
void	generateResponse(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, Object node) Writes this object as HTTP response.
String	getDescription()
String	getDisplayName()
String	getFileName() Returns the suggested file name for this recipe.
String	getId()
List<Ingredient>	getIngredients()
<T extends Ingredient> List<T>	getIngredients(Class<T> type)
List<Parameter>	getParameters()
String	getVersion()
static void	init()
static Recipe	load(URL url) Loads the recipe from URL.
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setId(String id)
void	setVersion(String version)
void	writeTo(OutputStream out)
void	writeTo(Writer out)

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

Field Detail

XSTREAM

public static hudson.util.XStream2 XSTREAM

EXTENSION

public static final String EXTENSION

Common file extension for Jenkins recipe.

See Also:

Constant Field Values

ID_PATTERN

public static final Pattern ID_PATTERN

Constructor Detail

Recipe

@DataBoundConstructor
public Recipe(String id,
                           String version,
                           String displayName,
                           String description,
                           List<? extends Ingredient> ingredients)

Method Detail

getId

public String getId()

setId

public void setId(String id)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

getFileName

public String getFileName()

Returns the suggested file name for this recipe.

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getIngredients

public List<Ingredient> getIngredients()

getParameters

public List<Parameter> getParameters()

getIngredients

public <T extends Ingredient> List<T> getIngredients(Class<T> type)

writeTo

public void writeTo(OutputStream out)
             throws IOException

Throws:

IOException

writeTo

public void writeTo(Writer out)
             throws IOException

Throws:

IOException

generateResponse

public void generateResponse(org.kohsuke.stapler.StaplerRequest req,
                    org.kohsuke.stapler.StaplerResponse rsp,
                    Object node)
                      throws IOException,
                             javax.servlet.ServletException

Writes this object as HTTP response.

Specified by:

generateResponse in interface org.kohsuke.stapler.HttpResponse

Throws:

IOException

javax.servlet.ServletException

apply

public void apply(org.kohsuke.stapler.StaplerRequest req)
           throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

cook

public void cook(ImportReportList reportList)
          throws IOException,
                 InterruptedException

Imports this ingredient into the current Jenkins.

Throws:

IOException

InterruptedException

createImportOptions

public Recipe.ImportOptions createImportOptions()

load

public static Recipe load(URL url)
                   throws IOException

Loads the recipe from URL.

Throws:

IOException

init

@Initializer(after=PLUGINS_STARTED)
public static void init()