Package hudson.plugins.promoted_builds

Class JobPropertyImpl

java.lang.Object

hudson.model.JobProperty<AbstractProject<?,?>>

hudson.plugins.promoted_builds.JobPropertyImpl

All Implemented Interfaces:

ExtensionPoint, Describable<JobProperty<?>>, ItemGroup<PromotionProcess>, ModelObject, PersistenceRoot, ReconfigurableDescribable<JobProperty<?>>, Saveable, BuildStep

public final class JobPropertyImpl
extends JobProperty<AbstractProject<?,?>>
implements ItemGroup<PromotionProcess>

Promotion processes defined for a project.

TODO: a possible performance problem as every time the owner job is reconfigured, all the promotion processes get reloaded from the disk.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobPropertyImpl.DescriptorImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.JobProperty

owner

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
JobPropertyImpl(AbstractProject<?,?> owner)	Programmatic construction.
JobPropertyImpl(JobPropertyImpl other, AbstractProject<?,?> owner)	Programmatic construction.
JobPropertyImpl(Set<String> activeProcessNames)	Programmatic construction.

Method Summary

Modifier and Type	Method	Description
PromotionProcess	addProcess(String name)	Adds a new promotion process of the given name.
PromotionProcess	createProcessFromXml(String name, InputStream xml)
List<PromotionProcess>	getActiveItems()	Gets the list of active promotion processes.
String	getDisplayName()
String	getFullDisplayName()
String	getFullName()
PromotionProcess	getItem(String name)	Finds a PromotionProcess by name.
List<PromotionProcess>	getItems()	Gets the list of promotion processes defined for this project, including ones that are no longer actively used and only for archival purpose.
Action	getJobAction(AbstractProject<?,?> job)	Deprecated.
AbstractProject<?,?>	getOwner()	Gets AbstractProject that contains us.
File	getRootDir()
File	getRootDirFor(PromotionProcess child)
String	getUrl()
String	getUrlChildPrefix()
void	onDeleted(PromotionProcess process)
void	onRenamed(PromotionProcess item, String oldName, String newName)
boolean	prebuild(AbstractBuild<?,?> build, BuildListener listener)
void	save()
protected void	setOwner(AbstractProject<?,?> owner)

Methods inherited from class hudson.model.JobProperty

getDescriptor, getJobActions, getJobOverrides, getProjectAction, getProjectActions, getRequiredMonitorService, getSubTasks, perform, reconfigure

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.ItemGroup

allItems, allItems, allItems, getAllItems, getAllItems, getAllItems, getItems, getItemsStream, getItemsStream

Constructor Detail

JobPropertyImpl

public JobPropertyImpl(AbstractProject<?,?> owner)
                throws Descriptor.FormException,
                       IOException

Programmatic construction.

Parameters:

owner - owner job

Throws:

Descriptor.FormException

IOException

JobPropertyImpl

public JobPropertyImpl(JobPropertyImpl other,
                       AbstractProject<?,?> owner)
                throws Descriptor.FormException,
                       IOException

Programmatic construction.

Parameters:

other - Property to be copied

owner - owner job

Throws:

Descriptor.FormException

IOException

JobPropertyImpl

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public JobPropertyImpl(Set<String> activeProcessNames)

Programmatic construction.

Method Detail

addProcess

public PromotionProcess addProcess(String name)
                            throws IOException

Adds a new promotion process of the given name.

Parameters:

name - Name of the process to be created

Returns:

Created process

Throws:

IOException - Execution error

setOwner

protected void setOwner(AbstractProject<?,?> owner)

Overrides:

setOwner in class JobProperty<AbstractProject<?,?>>

getItems

public List<PromotionProcess> getItems()

Gets the list of promotion processes defined for this project, including ones that are no longer actively used and only for archival purpose.

Specified by:

getItems in interface ItemGroup<PromotionProcess>

Returns:

non-null and non-empty. Read-only.

getActiveItems

public List<PromotionProcess> getActiveItems()

Gets the list of active promotion processes.

createProcessFromXml

public PromotionProcess createProcessFromXml(String name,
                                             InputStream xml)
                                      throws IOException

Throws:

IOException

See Also:

ItemGroupMixIn.createProjectFromXML(java.lang.String, java.io.InputStream)

getOwner

public AbstractProject<?,?> getOwner()

Gets AbstractProject that contains us.

Returns:

Owner project

getItem

@CheckForNull
public PromotionProcess getItem(String name)

Finds a PromotionProcess by name.

Specified by:

getItem in interface ItemGroup<PromotionProcess>

Parameters:

name - Name of the process

Returns:

PromotionProcess if it can be found.

getRootDir

public File getRootDir()

Specified by:

getRootDir in interface PersistenceRoot

save

public void save()
          throws IOException

Specified by:

save in interface Saveable

Throws:

IOException

onDeleted

public void onDeleted(PromotionProcess process)

Specified by:

onDeleted in interface ItemGroup<PromotionProcess>

onRenamed

public void onRenamed(PromotionProcess item,
                      String oldName,
                      String newName)
               throws IOException

Specified by:

onRenamed in interface ItemGroup<PromotionProcess>

Throws:

IOException

getUrl

public String getUrl()

Specified by:

getUrl in interface ItemGroup<PromotionProcess>

getFullName

public String getFullName()

Specified by:

getFullName in interface ItemGroup<PromotionProcess>

getFullDisplayName

public String getFullDisplayName()

Specified by:

getFullDisplayName in interface ItemGroup<PromotionProcess>

getUrlChildPrefix

public String getUrlChildPrefix()

Specified by:

getUrlChildPrefix in interface ItemGroup<PromotionProcess>

getRootDirFor

public File getRootDirFor(PromotionProcess child)

Specified by:

getRootDirFor in interface ItemGroup<PromotionProcess>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

prebuild

public boolean prebuild(AbstractBuild<?,?> build,
                        BuildListener listener)

Specified by:

prebuild in interface BuildStep

Overrides:

prebuild in class JobProperty<AbstractProject<?,?>>

getJobAction

@Deprecated
public Action getJobAction(AbstractProject<?,?> job)

Deprecated.

Overrides:

getJobAction in class JobProperty<AbstractProject<?,?>>