Hudson-ci/extension-points-doc

From Eclipsepedia

Jump to: navigation, search

Hudson defines extension points, which are interfaces or abstract classes that model an aspect of a build system. Those interfaces define contracts of what need to be implemented, and Hudson allows plugins to contribute those implementations. In general, all you need to do to register an implementation is to mark it with Template:@Extension.

Currently the following extension points are available. See Javadoc for more details about the contracts:


h4. AdministrativeMonitor

Checks the health of a subsystem of Hudson and if there's something that requires administrator's attention, notify the administrator.

h4. [AuthorizationStrategy|http://hudson-ci.org/javadoc/hudson/security/AuthorizationStrategy.html]

Controls authorization throughout Hudson.

h4. [Axis|http://hudson-ci.org/javadoc/hudson/matrix/Axis.html]

Configuration axis.

h4. [BuildWrapper|http://hudson-ci.org/javadoc/hudson/tasks/BuildWrapper.html]

Pluggability point for performing pre/post actions for the build process.

h4. [Builder|http://hudson-ci.org/javadoc/hudson/tasks/Builder.html]

[BuildStep|http://hudson-ci.org/javadoc/hudson/tasks/BuildStep.html]s that perform the actual build.

h4. [CLICommand|http://hudson-ci.org/javadoc/hudson/cli.CLICommand.html]

Base class for Hudson CLI.

h4. [ChangeLogAnnotator|http://hudson-ci.org/javadoc/hudson/scm/ChangeLogAnnotator.html]

Performs mark up on changelog messages to be displayed.

h4. [Cloud|http://hudson-ci.org/javadoc/hudson/slaves/Cloud.html]

Creates [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html]s to dynamically expand/shrink the slaves attached to Hudson.

h4. [ComputerConnector|http://hudson-ci.org/javadoc/hudson/slaves/ComputerConnector.html]

Factory of [ComputerLauncher|http://hudson-ci.org/javadoc/hudson/slaves/ComputerLauncher.html].

h4. [ComputerLauncher|http://hudson-ci.org/javadoc/hudson/slaves/ComputerLauncher.html]

Extension point to allow control over how [Computer|http://hudson-ci.org/javadoc/hudson/model/Computer.html]s are "launched", meaning how they get connected to their slave agent program.

h4. [ComputerListener|http://hudson-ci.org/javadoc/hudson/slaves/ComputerListener.html]

Receives notifications about status changes of [Computer|http://hudson-ci.org/javadoc/hudson/model/Computer.html]s.

h4. [ComputerPinger|http://hudson-ci.org/javadoc/hudson/model/ComputerPinger.html]

A way to see if a computer is reachable.

h4. [ConsoleAnnotationDescriptor|http://hudson-ci.org/javadoc/hudson/console/ConsoleAnnotationDescriptor.html]

Descriptor for [ConsoleNote|http://hudson-ci.org/javadoc/hudson/console/ConsoleNote.html].

h4. [ConsoleAnnotatorFactory|http://hudson-ci.org/javadoc/hudson/console/ConsoleAnnotatorFactory.html]

Entry point to the [ConsoleAnnotator|http://hudson-ci.org/javadoc/hudson/console/ConsoleAnnotator.html] extension point. This class creates a new instance of [ConsoleAnnotator|http://hudson-ci.org/javadoc/hudson/console/ConsoleAnnotator.html] that starts a new console annotation session.

h4. [ConsoleLogFilter|http://hudson-ci.org/javadoc/hudson/console/ConsoleLogFilter.html]

A hook to allow filtering of information that is written to the console log. Unlike [ConsoleAnnotator|http://hudson-ci.org/javadoc/hudson/console/ConsoleAnnotator.html] and [ConsoleNote|http://hudson-ci.org/javadoc/hudson/console/ConsoleNote.html], this class provides direct access to the underlying Template:OutputStream so it's possible to suppress data, which isn't possible from the other interfaces.

h4. [CrumbIssuer|http://hudson-ci.org/javadoc/hudson/security/csrf/CrumbIssuer.html]

A CrumbIssuer represents an algorithm to generate a nonce value, known as a crumb, to counter cross site request forgery exploits. Crumbs are typically hashes incorporating information that uniquely identifies an agent that sends a request, along with a guarded secret so that the crumb value cannot be forged by a third party.

h4. [Downloadable|http://hudson-ci.org/javadoc/hudson/model/DownloadService.Downloadable.html]

Represents a periodically updated JSON data file obtained from a remote URL.

h4. [ExtensionFinder|http://hudson-ci.org/javadoc/hudson/ExtensionFinder.html]

Discovers the implementations of an extension point.

h4. [FileSystemProvisioner|http://hudson-ci.org/javadoc/hudson/FileSystemProvisioner.html]

Prepares and provisions workspaces for [AbstractProject|http://hudson-ci.org/javadoc/hudson/model/AbstractProject.html]s.

h4. [FileSystemProvisionerDescriptor|http://hudson-ci.org/javadoc/hudson/FileSystemProvisionerDescriptor.html]

[Descriptor|http://hudson-ci.org/javadoc/hudson/model/Descriptor.html] for [FileSystemProvisioner|http://hudson-ci.org/javadoc/hudson/FileSystemProvisioner.html].

h4. [ItemListener|http://hudson-ci.org/javadoc/hudson/model/listeners/ItemListener.html]

Receives notifications about CRUD operations of Template:Item.

h4. [Job|http://hudson-ci.org/javadoc/hudson/model/Job.html]

A job is an runnable entity under the monitoring of Hudson.

h4. [JobProperty|http://hudson-ci.org/javadoc/hudson/model/JobProperty.html]

Extensible property of [Job|http://hudson-ci.org/javadoc/hudson/model/Job.html].

h4. [LabelAtomProperty|http://hudson-ci.org/javadoc/hudson/model/labels/LabelAtomProperty.html]

Extensible property of [LabelAtom|http://hudson-ci.org/javadoc/hudson/model/labels/LabelAtom.html].

h4. [LabelFinder|http://hudson-ci.org/javadoc/hudson/model/LabelFinder.html]

Automatically adds labels to [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html]s.

h4. [LauncherDecorator|http://hudson-ci.org/javadoc/hudson/LauncherDecorator.html]

Decorates [Launcher|http://hudson-ci.org/javadoc/hudson/Launcher.html] so that one can intercept executions of commands and alters the command being executed, such as doing this in fakeroot, sudo, pfexec, etc.

h4. [Lifecycle|http://hudson-ci.org/javadoc/hudson/lifecycle/Lifecycle.html]

Provides the capability for starting/stopping/restarting/uninstalling Hudson.

h4. [ListViewColumn|http://hudson-ci.org/javadoc/hudson/views/ListViewColumn.html]

Extension point for adding a column to [ListView|http://hudson-ci.org/javadoc/hudson/model/ListView.html].

h4. [LoadPredictor|http://hudson-ci.org/javadoc/hudson/model/queue/LoadPredictor.html]

Predicts future load to the system, to assist the scheduling decisions

h4. [MailAddressResolver|http://hudson-ci.org/javadoc/hudson/tasks/MailAddressResolver.html]

Infers e-mail addresses for the user when none is specified.

h4. [ManagementLink|http://hudson-ci.org/javadoc/hudson/model/ManagementLink.html]

Extension point to add icon to {{[1]}} page.

h4. [MatrixAggregatable|http://hudson-ci.org/javadoc/hudson/matrix/MatrixAggregatable.html]

[Publisher|http://hudson-ci.org/javadoc/hudson/tasks/Publisher.html] can optionally implement this interface  to perform result aggregation across [MatrixRun|http://hudson-ci.org/javadoc/hudson/matrix/MatrixRun.html].

h4. [MatrixAggregator|http://hudson-ci.org/javadoc/hudson/matrix/MatrixAggregator.html]

Performs the aggregation of [MatrixRun|http://hudson-ci.org/javadoc/hudson/matrix/MatrixRun.html] results into [MatrixBuild|http://hudson-ci.org/javadoc/hudson/matrix/MatrixBuild.html].

h4. [MyViewsTabBar|http://hudson-ci.org/javadoc/hudson/views/MyViewsTabBar.html]

Extension point for adding a MyViewsTabBar header to Projects [MyViewsProperty|http://hudson-ci.org/javadoc/hudson/model/MyViewsProperty.html].

h4. [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html]

Base type of Hudson slaves (although in practice, you probably extend [Slave|http://hudson-ci.org/javadoc/hudson/model/Slave.html] to define a new slave type.)

h4. [NodeMonitor|http://hudson-ci.org/javadoc/hudson/node_monitors.NodeMonitor.html]

Extension point for managing and monitoring [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html]s.

h4. [NodeProperty|http://hudson-ci.org/javadoc/hudson/slaves/NodeProperty.html]

Extensible property of [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html].

h4. [Notifier|http://hudson-ci.org/javadoc/hudson/tasks/Notifier.html]

[BuildStep|http://hudson-ci.org/javadoc/hudson/tasks/BuildStep.html]s that run after the build is completed.

h4. [PageDecorator|http://hudson-ci.org/javadoc/hudson/model/PageDecorator.html]

Participates in the rendering of HTML pages for all pages of Hudson.

h4. [ParameterDefinition|http://hudson-ci.org/javadoc/hudson/model/ParameterDefinition.html]

Defines a parameter for a build.

h4. [PeriodicWork|http://hudson-ci.org/javadoc/hudson/model/PeriodicWork.html]

Extension point to perform a periodic task in Hudson (through Template:Timer.)

h4. [PluginServletFilter|http://hudson-ci.org/javadoc/hudson/util.PluginServletFilter.html]

Servlet [Filter|http://hudson-ci.org/javadoc/hudson/util.DirScanner.Filter.html] that chains multiple [Filter|http://hudson-ci.org/javadoc/hudson/util.DirScanner.Filter.html]s, provided by plugins

h4. [PluginStrategy|http://hudson-ci.org/javadoc/hudson/PluginStrategy.html]

Pluggability point for how to create [PluginWrapper|http://hudson-ci.org/javadoc/hudson/PluginWrapper.html].

h4. [ProcessKiller|http://hudson-ci.org/javadoc/hudson/util.ProcessKiller.html]

Extension point that defines more elaborate way of killing processes, such as sudo or pfexec, for [ProcessTree|http://hudson-ci.org/javadoc/hudson/util.ProcessTree.html].

h4. [QueueDecisionHandler|http://hudson-ci.org/javadoc/hudson/model/queue/QueueDecisionHandler.html]

Extension point for deciding if particular job should be scheduled or not.

h4. [QueueSorter|http://hudson-ci.org/javadoc/hudson/model/queue/QueueSorter.html]

Singleton extension point for sorting buildable items

h4. [QueueTaskDispatcher|http://hudson-ci.org/javadoc/hudson/model/queue/QueueTaskDispatcher.html]

Vetos the execution of a task on a node

h4. [Recorder|http://hudson-ci.org/javadoc/hudson/tasks/Recorder.html]

[BuildStep|http://hudson-ci.org/javadoc/hudson/tasks/BuildStep.html]s that run after the build is completed.

h4. [RepositoryBrowser|http://hudson-ci.org/javadoc/hudson/scm/RepositoryBrowser.html]

Connects Hudson to repository browsers like ViewCVS or FishEye, so that Hudson can generate links to them.

h4. [RestartListener|http://hudson-ci.org/javadoc/hudson/model/RestartListener.html]

Extension point that allows plugins to veto the restart.

h4. [RetentionStrategy|http://hudson-ci.org/javadoc/hudson/slaves/RetentionStrategy.html]

Controls when to take [Computer|http://hudson-ci.org/javadoc/hudson/model/Computer.html] offline, bring it back online, or even to destroy it.

h4. [RootAction|http://hudson-ci.org/javadoc/hudson/model/RootAction.html]

Marker interface for actions that are added to [Hudson|http://hudson-ci.org/javadoc/hudson/model/Hudson.html].

h4. [Run|http://hudson-ci.org/javadoc/hudson/model/Run.html]

A particular execution of [Job|http://hudson-ci.org/javadoc/hudson/model/Job.html].

h4. [RunListener|http://hudson-ci.org/javadoc/hudson/model/listeners/RunListener.html]

Receives notifications about builds.

h4. [SCM|http://hudson-ci.org/javadoc/hudson/scm/SCM.html]

Captures the configuration information in it.

h4. [SCMListener|http://hudson-ci.org/javadoc/hudson/model/listeners/SCMListener.html]

Receives notifications about SCM activities in Hudson.

h4. [SaveableListener|http://hudson-ci.org/javadoc/hudson/model/listeners/SaveableListener.html]

Receives notifications about save actions on [Saveable|http://hudson-ci.org/javadoc/hudson/model/Saveable.html] objects in Hudson.

h4. [SecurityRealm|http://hudson-ci.org/javadoc/hudson/security/SecurityRealm.html]

Pluggable security realm that connects external user database to Hudson.

h4. [Solution|http://hudson-ci.org/javadoc/hudson/diagnosis/HudsonHomeDiskUsageMonitor/Solution.html]

Extension point for suggesting solutions for full HUDSON_HOME.

h4. [SubTaskContributor|http://hudson-ci.org/javadoc/hudson/model/queue/SubTaskContributor.html]

Externally contributes [SubTask|http://hudson-ci.org/javadoc/hudson/model/queue/SubTask.html]s to Template:AbstractProject.

h4. [TestDataPublisher|http://hudson-ci.org/javadoc/hudson/tasks/junit/TestDataPublisher.html]

Contributes [TestAction|http://hudson-ci.org/javadoc/hudson/tasks/junit/TestAction.html]s to test results.

h4. [TestResultParser|http://hudson-ci.org/javadoc/hudson/tasks/test/TestResultParser.html]

Parses test result files and builds in-memory representation of it as Template:TestResult.

h4. [ToolInstallation|http://hudson-ci.org/javadoc/hudson/tools/ToolInstallation.html]

Formalization of a tool installed in nodes used for builds (examples include things like JDKs, Ants, Mavens, and Groovys)

h4. [ToolInstaller|http://hudson-ci.org/javadoc/hudson/tools/ToolInstaller.html]

An object which can ensure that a generic [ToolInstallation|http://hudson-ci.org/javadoc/hudson/tools/ToolInstallation.html] in fact exists on a node.

h4. [ToolLocationTranslator|http://hudson-ci.org/javadoc/hudson/tools/ToolLocationTranslator.html]

This Hudson-wide extension points can participate in determining the actual node-specific path of the [ToolInstallation|http://hudson-ci.org/javadoc/hudson/tools/ToolInstallation.html] for the given [Node|http://hudson-ci.org/javadoc/hudson/model/Node.html].

h4. [ToolProperty|http://hudson-ci.org/javadoc/hudson/tools/ToolProperty.html]

Extensible property of [ToolInstallation|http://hudson-ci.org/javadoc/hudson/tools/ToolInstallation.html].

h4. [TopLevelItem|http://hudson-ci.org/javadoc/hudson/model/TopLevelItem.html]

Template:Item that can be directly displayed under [Hudson|http://hudson-ci.org/javadoc/hudson/model/Hudson.html].

h4. [TransientProjectActionFactory|http://hudson-ci.org/javadoc/hudson/model/TransientProjectActionFactory.html]

Extension point for inserting transient [Action|http://hudson-ci.org/javadoc/hudson/model/Action.html]s into [AbstractProject|http://hudson-ci.org/javadoc/hudson/model/AbstractProject.html]s.

h4. [TransientViewActionFactory|http://hudson-ci.org/javadoc/hudson/model/TransientViewActionFactory.html]

Extension point for adding transient [Action|http://hudson-ci.org/javadoc/hudson/model/Action.html]s to [View|http://hudson-ci.org/javadoc/hudson/model/View.html]s.

h4. [Trigger|http://hudson-ci.org/javadoc/hudson/triggers/Trigger.html]

Triggers a [Build|http://hudson-ci.org/javadoc/hudson/model/Build.html].

h4. [UDPBroadcastFragment|http://hudson-ci.org/javadoc/hudson/UDPBroadcastFragment.html]

Extension point that contributes an XML fragment to the UDP broadcast.

h4. [UpdateCenterConfiguration|http://hudson-ci.org/javadoc/hudson/model/UpdateCenter/UpdateCenterConfiguration.html]

Strategy object for controlling the update center's behaviors.

h4. [UserNameResolver|http://hudson-ci.org/javadoc/hudson/tasks/UserNameResolver.html]

Finds full name off the user when none is specified.

h4. [UserProperty|http://hudson-ci.org/javadoc/hudson/model/UserProperty.html]

Extensible property of [User|http://hudson-ci.org/javadoc/hudson/model/User.html].

h4. [View|http://hudson-ci.org/javadoc/hudson/model/View.html]

Encapsulates the rendering of the list of [TopLevelItem|http://hudson-ci.org/javadoc/hudson/model/TopLevelItem.html]s that [Hudson|http://hudson-ci.org/javadoc/hudson/model/Hudson.html] owns.

h4. [ViewJobFilter|http://hudson-ci.org/javadoc/hudson/views/ViewJobFilter.html]

Each ViewJobFilter contributes to or removes from the list of Jobs for a view.

h4. [ViewsTabBar|http://hudson-ci.org/javadoc/hudson/views/ViewsTabBar.html]

Extension point for adding a ViewsTabBar header to Projects [ListView|http://hudson-ci.org/javadoc/hudson/model/ListView.html].

h4. [Widget|http://hudson-ci.org/javadoc/hudson/widgets/Widget.html]

Box to be rendered in the side panel.