Package hudson.model

Core object model that are bound to URLs via stapler, rooted at Hudson.

See: Description

Interface Summary

Interface	Description
Action	Object that contributes additional information, behaviors, and UIs to ModelObject (more specifically Actionable objects, which most interesting ModelObjects are.)
BuildableItem	Item that can be "built", for whatever meaning of "build".
BuildableItemWithBuildWrappers	AbstractProject that has associated BuildWrappers.
BuildBadgeAction	Action that puts a little icon (or icons) next to the build in the build history.
BuildListener	Receives events that happen during a build.
DependecyDeclarer	Deprecated Use DependencyDeclarer instead.
Describable<T extends Describable<T>>	Classes that are described by Descriptor.
DescriptorByNameOwner	Adds DescriptorByNameOwner.getDescriptorByName(String) to bind Descriptors to URL.
DirectlyModifiableView	Marker interface for View its items can be modified.
EnvironmentContributingAction	Action that contributes environment variables during a build.
EnvironmentSpecific<T extends EnvironmentSpecific<T>>	Represents any concept that can be adapted for a certain environment.
ExecutorListener	A listener for task related events from Executors
HealthReportingAction	An Action that can return information about the health of the Job.
Item	Basic configuration unit in Hudson.
ItemGroup<T extends Item>	Represents a grouping inherent to a kind of Items.
ModelObject	A model object has a human readable name.
ModifiableItemGroup<T extends Item>	ItemGroup that is a general purpose container, which allows users and the rest of the program to create arbitrary items into it.
ModifiableViewGroup	ViewGroup that can be modified.
PermalinkProjectAction	Optional interface for Actions that are attached to AbstractProject (through JobProperty.getJobActions(Job)), which allows plugins to define additional permalinks in the project.
PersistenceRoot	Root object of a persisted object tree that gets its own file system directory.
ProminentProjectAction	Marker interface for Actions that should be displayed at the top of the project page.
Queue.Executable	Represents the real meat of the computation run by Executor.
Queue.FlyweightTask	Marks Queue.Tasks that do not consume Executor.
Queue.NonBlockingTask	Marks Queue.Tasks that are not affected by the Jenkins.isQuietingDown() quieting down}, because these tasks keep other tasks executing.
Queue.QueueAction	An optional interface for actions on Queue.Item.
Queue.Task	Task whose execution is controlled by the queue.
Queue.TransientTask	Marks Queue.Tasks that are not persisted.
ReconfigurableDescribable<T extends ReconfigurableDescribable<T>>	Marks modern Describables that allow the current instances to pass information down to the next instance when the configuration is submitted.
ResourceActivity	Activity that requires certain resources for its execution.
RootAction	Marker interface for actions that are added to Jenkins.
RunAction	Deprecated Use RunAction2 instead: RunAction.onLoad() does not work well with lazy loading if you are trying to persist the owner; and RunAction.onBuildComplete() was never called.
RunMap.Constructor<R extends Run<?,R>>	Run factory.
Saveable	Object whose state is persisted to XML.
SCMedItem	Deprecated Implement SCMTriggerItem instead.
StatusIcon	Item can return this from the "getIconColor" method so that its "status icon" can be shown in Hudson UI.
TaskListener	Receives events that happen during some lengthy operation that has some chance of failures, such as a build, SCM change polling, slave launch, and so on.
TopLevelItem	Item that can be directly displayed under Jenkins or other containers.
UnprotectedRootAction	RootActions that are accessible to requests that do not have the READ permission on Jenkins.
ViewGroup	Container of Views.

Class Summary

Class	Description
AbstractBuild<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>>	Base implementation of Runs that build software.
AbstractBuild.DependencyChange	Represents a change in the dependency.
AbstractCIBase
AbstractDescribableImpl<T extends AbstractDescribableImpl<T>>	Partial default implementation of Describable.
AbstractItem	Partial default implementation of Item.
AbstractModelObject	ModelObject with some convenience methods.
AbstractProject<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>>	Base implementation of Jobs that build software.
AbstractProject.AbstractProjectDescriptor	AbstractProject subtypes should implement this base class as a descriptor.
AbstractProject.BecauseOfBuildInProgress	Blocked because the previous build is already in progress.
AbstractProject.BecauseOfDownstreamBuildInProgress	Because the downstream build is in progress, and we are configured to wait for that.
AbstractProject.BecauseOfUpstreamBuildInProgress	Because the upstream build is in progress, and we are configured to wait for that.
AbstractProject.LabelValidator	Plugins may want to contribute additional restrictions on the use of specific labels for specific projects.
AbstractStatusIcon	Partial base class for StatusIcon.
Actionable	ModelObject that can have additional Actions.
AdministrativeMonitor	Checks the health of a subsystem of Jenkins and if there's something that requires administrator's attention, notify the administrator.
AllView	View that contains everything.
AllView.DescriptorImpl
AperiodicWork	Extension point which allows scheduling a task with variable interval.
Api	Used to expose remote access API for ".../api/"
AsyncAperiodicWork	AperiodicWork that takes a long time to run.
AsyncPeriodicWork	PeriodicWork that takes a long time to run.
AutoCompletionCandidates	Data representation of the auto-completion candidates.
BooleanParameterDefinition	ParameterDefinition that is either 'true' or 'false'.
BooleanParameterDefinition.DescriptorImpl
BooleanParameterValue	ParameterValue created from BooleanParameterDefinition.
Build<P extends Project<P,B>,B extends Build<P,B>>	A build of a Project.
BuildAuthorizationToken	Deprecated 2008-07-20 Use ACL and Item.BUILD.
BuildAuthorizationToken.ConverterImpl
BuildStepListener	Receives events that happen as a build executes BuildSteps.
BuildTimelineWidget	UI widget for showing the SIMILE timeline control.
BuildVariableContributor	Contributes build variables to builds.
Cause	Cause object base class.
Cause.LegacyCodeCause	Deprecated since 2009-02-08
Cause.RemoteCause
Cause.UpstreamCause	A build is triggered by the completion of another build (AKA upstream build.)
Cause.UpstreamCause.ConverterImpl
Cause.UpstreamCause.DeeplyNestedUpstreamCause
Cause.UserCause	Deprecated 1.428 use Cause.UserIdCause
Cause.UserIdCause	A build is started by an user action.
CauseAction
CauseAction.ConverterImpl
CheckPoint	Provides a mechanism for synchronizing build executions in the face of concurrent builds.
ChoiceParameterDefinition
ChoiceParameterDefinition.DescriptorImpl
Computer	Represents the running state of a remote computer that holds Executors.
ComputerPanelBox	Adds box rendered in the computer side panel.
ComputerPinger	A way to see if a computer is reachable.
ComputerPinger.BuiltInComputerPinger	Default pinger - use Java built-in functionality.
ComputerSet	Serves as the top of Computers in the URL hierarchy.
ComputerSet.DescriptorImpl
DependencyGraph	Maintains the build dependencies between AbstractProjects for efficient dependency computation.
DependencyGraph.Dependency	Represents an edge in the dependency graph.
Descriptor<T extends Describable<T>>	Metadata about a configurable instance.
Descriptor.PropertyType	Represents a readable property on Describable.
Descriptor.Self	Special type indicating that Descriptor describes itself.
DescriptorVisibilityFilter	Hides Descriptors from users.
DirectoryBrowserSupport	Has convenience methods to serve file system.
DirectoryBrowserSupport.Path	Represents information about one file or folder.
DisplayNameListener
DownloadService	Service for plugins to periodically retrieve update data files (like the one in the update center) through browsers.
DownloadService.Downloadable	Represents a periodically updated JSON data file obtained from a remote URL.
Environment	Represents some resources that are set up for the duration of a build to be torn down when the build is over.
EnvironmentContributor	Contributes environment variables to builds.
EnvironmentContributor.EnvVarsHtml	Serves the combined list of environment variables available from this plugin.
EnvironmentList	List of Environment.
Executor	Thread that executes builds.
FileParameterDefinition	ParameterDefinition for doing file upload.
FileParameterDefinition.DescriptorImpl
FileParameterValue	ParameterValue for FileParameterDefinition.
FileParameterValue.FileItemImpl	Default implementation from File.
Fingerprint	A file being tracked by Jenkins.
Fingerprint.BuildPtr	Pointer to a Build.
Fingerprint.ProjectRenameListener
Fingerprint.Range	Range of build numbers [start,end).
Fingerprint.RangeItem
Fingerprint.RangeSet	Set of Fingerprint.Ranges.
FingerprintCleanupThread	Scans the fingerprint database and remove old records that are no longer relevant.
FingerprintMap	Cache of Fingerprints.
FreeStyleBuild
FreeStyleProject	Free-style software project.
FreeStyleProject.DescriptorImpl
FullDuplexHttpChannel	Builds a Channel on top of two HTTP streams (one used for each direction.)
HealthReport	Represents health of something (typically project).
HealthReport.ConverterImpl	Fix deserialization of older data.
Hudson
Hudson.CloudList	Deprecated only here for backward comp
Hudson.MasterComputer	Deprecated only here for backward comp
InvisibleAction	Partial Action implementation that doesn't have any UI presence.
ItemGroupMixIn	Defines a bunch of static methods to be used as a "mix-in" for ItemGroup implementations.
Items	Convenience methods related to Item.
ItemVisitor	Walks the tree structure that consists of ItemGroup and Item.
JDK	Information about JDK installation.
JDK.ConverterImpl
JDK.DescriptorImpl
Job<JobT extends Job<JobT,RunT>,RunT extends Run<JobT,RunT>>	A job is an runnable entity under the monitoring of Hudson.
Job.LastItemListener
JobParameterDefinition
JobParameterDefinition.DescriptorImpl
JobParameterValue
JobProperty<J extends Job<?,?>>	Extensible property of Job.
JobPropertyDescriptor	Descriptor for JobProperty.
Jobs	Deprecated since 1.281
Label	Group of Nodes.
Label.ConverterImpl
LabelFinder	Automatically adds labels to Nodes.
LargeText	Deprecated moved to stapler, as of Hudson 1.220
ListView	Displays Jobs in a flat list view.
ListView.DescriptorImpl
ListView.Listener
LoadBalancer	Strategy that decides which Queue.Task gets run on which Executor.
LoadStatistics	Utilization statistics for a node or a set of nodes.
LoadStatistics.LoadStatisticsUpdater	Periodically update the load statistics average.
ManageJenkinsAction	Adds the "Manage Jenkins" link to the top page.
ManagementLink	Extension point to add icon to http://server/hudson/manage page.
Messages
MultiStageTimeSeries	Maintains several TimeSeries with different update frequencies to satisfy three goals; (1) retain data over long timespan, (2) save memory, and (3) retain accurate data for the recent past.
MultiStageTimeSeries.TrendChart	Represents the trend chart that consists of several MultiStageTimeSeries.
MyView	View that only contains projects for which the current user has access to.
MyView.DescriptorImpl
MyViewsProperty	A UserProperty that remembers user-private views.
MyViewsProperty.DescriptorImpl
MyViewsProperty.GlobalAction
Node	Base type of Jenkins slaves (although in practice, you probably extend Slave to define a new slave type.)
Node.InternalComputerListener	Let Nodes be aware of the lifecycle of their own Computer.
NoFingerprintMatch
OneOffExecutor	Executor that's temporarily added to carry out tasks that doesn't consume regular executors, like a matrix project parent build.
OverallLoadStatistics	LoadStatistics for the entire system (the master and all the slaves combined), and all the jobs that are running on it.
PageDecorator	Participates in the rendering of HTML pages for all pages of Hudson.
PaneStatusProperties
PaneStatusProperties.DescriptorImpl
ParameterDefinition	Defines a parameter for a build.
ParameterDefinition.ParameterDescriptor
ParametersAction	Records the parameter values used for a build.
ParametersDefinitionProperty	Keeps a list of the parameters defined for a project.
ParametersDefinitionProperty.DescriptorImpl
ParameterValue	A value for a parameter in a build.
PasswordParameterDefinition	Parameter whose value is a Secret and is hidden from the UI.
PasswordParameterDefinition.ParameterDescriptorImpl
PasswordParameterValue
PeriodicWork	Extension point to perform a periodic task in Hudson (through Timer.)
PermalinkProjectAction.Permalink	Permalink as a strategy pattern.
Project<P extends Project<P,B>,B extends Build<P,B>>	Buildable software project.
ProxyView	A view that delegates to another.
ProxyView.DescriptorImpl
Queue	Build queue.
Queue.BuildableItem	Item in the Queue.buildables stage.
Queue.Item	Item in a queue.
Queue.LeftItem	Item in the Queue.leftItems stage.
Queue.NotWaitingItem	Common part between Queue.BlockedItem and BuildableItem.
Queue.QueueDecisionHandler	Extension point for deciding if particular job should be scheduled or not.
Queue.WaitingItem	Item in the Queue.waitingList stage.
Resource	Represents things that Queue.Executable uses while running.
ResourceController	Controls mutual exclusion of ResourceList.
ResourceList	List of Resources that an activity needs.
RestartListener	Extension point that allows plugins to veto the restart.
RestartListener.Default	Default logic.
Result	The build outcome.
Result.OptionHandlerImpl
RSS	RSS related code.
Run<JobT extends Job<JobT,RunT>,RunT extends Run<JobT,RunT>>	A particular execution of Job.
Run.RedirectUp
Run.Summary
RunMap<R extends Run<?,R>>	Map from build number to Run.
RunParameterDefinition
RunParameterDefinition.DescriptorImpl
RunParameterValue
SimpleParameterDefinition	Convenient base class for ParameterDefinition whose value can be represented in a context-independent single string token.
Slave	Information about a Hudson slave node.
Slave.JnlpJar	Web-bound object used to serve jar files for JNLP.
Slave.SlaveDescriptor
StockStatusIcon	StatusIcon for stock icon in Hudson.
StreamBuildListener	BuildListener that writes to an OutputStream.
StringParameterDefinition	Parameter whose value is a string value.
StringParameterDefinition.DescriptorImpl
StringParameterValue	ParameterValue created from StringParameterDefinition.
TaskAction	Partial Action implementation for those who kick some processing asynchronously (such as SCM tagging.)
TaskThread	Thread for performing one-off task.
TaskThread.ListenerAndText	Tuple of TaskListener and AnnotatedLargeText, representing the interface for producing output and how to retrieve it later.
TextParameterDefinition	StringParameterDefinition that uses textarea, instead of text box.
TextParameterDefinition.DescriptorImpl
TextParameterValue
TimeSeries	Scalar value that changes over the time (such as load average, Q length, # of executors, etc.)
TopLevelItemDescriptor	Descriptor for TopLevelItems.
TransientBuildActionFactory	Deprecated Does not contribute to Actionable.getActions().
TransientComputerActionFactory	Extension point for inserting transient Actions to Computers.
TransientProjectActionFactory	Extension point for inserting transient Actions into AbstractProjects.
TransientUserActionFactory	Extension point for inserting transient Actions into Users.
TransientViewActionFactory	Extension point for adding transient Actions to Views.
TreeView	EXPERIMENTAL
TreeView.DescriptorImpl
UpdateCenter	Controls update center capability.
UpdateCenter.CoreUpdateMonitor	AdministrativeMonitor that checks if there's Jenkins update.
UpdateCenter.PageDecoratorImpl	Adds the update center data retriever to HTML.
UpdateCenter.PluginEntry
UpdateCenter.UpdateCenterConfiguration	Strategy object for controlling the update center's behaviors.
UpdateSite	Source of the update center information, like "http://jenkins-ci.org/update-center.json"
UpdateSite.Entry
UsageStatistics
UsageStatistics.CombinedCipherInputStream	The opposite of the UsageStatistics.CombinedCipherOutputStream.
UsageStatistics.CombinedCipherOutputStream	Assymetric cipher is slow and in case of Sun RSA implementation it can only encyrypt the first block.
User	Represents a user.
User.CanonicalIdResolver
User.FullNameIdResolver	Resolve user ID from full name
UserProperties	Deprecated as of 1.286
UserProperty	Extensible property of User.
UserPropertyDescriptor	Descriptor for UserProperty.
View	Encapsulates the rendering of the list of TopLevelItems that Jenkins owns.
View.AsynchPeople	Variant of View.AsynchPeople.People which can be displayed progressively, since it may be slow.
View.People
View.PropertyList
View.UserInfo
ViewDescriptor	Descriptor for View.
ViewGroupMixIn	Implements ViewGroup to be used as a "mix-in".
ViewJob<JobT extends ViewJob<JobT,RunT>,RunT extends Run<JobT,RunT>>	Job that monitors activities that happen outside Hudson, which requires occasional batch reload activity to obtain the up-to-date information.
ViewProperty	Extensible property of View.
ViewPropertyDescriptor	Descriptor for ViewProperty
WorkspaceBrowser	Allows to access a workspace as an alternative to online build node.
WorkspaceCleanupThread	Clean up old left-over workspaces from slaves.
WorkspaceListener

Enum Summary

Enum	Description
BallColor	Ball color used for the build status indication.
MultiStageTimeSeries.TimeScale	Choose which datapoint to use.
Node.Mode	Constants that control how Hudson allocates jobs to slaves.
ResultTrend	Describes an Result trend by taking the comparing the result of the current and the previous build.
RunParameterDefinition.RunParameterFilter	Constants that control how Run Parameter is filtered.

Exception Summary

Exception	Description
Descriptor.FormException
Failure	Represents an error induced by user, encountered during HTTP request processing.
Run.RunnerAbortedException	Used in Run.RunExecution.run(hudson.model.BuildListener) to indicates that a fatal error in a build is reported to BuildListener and the build should be simply aborted without further recording a stack trace.

Package hudson.model Description

Core object model that are bound to URLs via stapler, rooted at Hudson.