Extension Points defined in Jenkins Core

Table of Contents

AbstractProject.LabelValidator

hudson.model.AbstractProject.LabelValidator

Plugins may want to contribute additional restrictions on the use of specific labels for specific projects. This extension point allows such restrictions.

Implementations:

(no known implementations)

AdministrativeMonitor

hudson.model.AdministrativeMonitor

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

Implementations:

AgentProtocol

jenkins.AgentProtocol

Pluggable Jenkins TCP agent protocol handler called from TcpSlaveAgentListener .

Implementations:

AlternativeUiTextProvider

hudson.util.AlternativeUiTextProvider

Provides the alternative text to be rendered in the UI.

Implementations:

AperiodicWork

hudson.model.AperiodicWork

Extension point which allows scheduling a task with variable interval. Interval in evaluated every time before next task is scheduled by calling #getRecurrencePeriod() . Task to be scheduled is obtain by calling #getNewInstance() .

Implementations:

ArtifactManagerFactory

jenkins.model.ArtifactManagerFactory

Pluggable ability to manage transfer and/or storage of build artifacts. The descriptor should specify at least a display name, and optionally a {@code config} view. Since the user can configure this class, you must have a DataBoundConstructor .

Implementations:

AuthorizationStrategy

hudson.security.AuthorizationStrategy

Controls authorization throughout Hudson.

Implementations:

BasicHeaderAuthenticator

jenkins.security.BasicHeaderAuthenticator

When Jenkins receives HTTP basic authentication, this hook will validate the username/password pair.

Implementations:

BuildDiscarder

jenkins.model.BuildDiscarder

Implementation of "Discard old build records" feature.

Implementations:

BuildReference.HolderFactory

jenkins.model.lazy.BuildReference.HolderFactory

Extensible factory for creating build references.

Implementations:

BuildStepListener

hudson.model.BuildStepListener

Receives events that happen as a build executes BuildStep s.

Implementations:

BuildVariableContributor

hudson.model.BuildVariableContributor

Contributes build variables to builds.

Implementations:

BuildWrapper

hudson.tasks.BuildWrapper

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

Implementations:

Builder

hudson.tasks.Builder

BuildStep s that perform the actual build.

Implementations:

CLICommand

hudson.cli.CLICommand

Base class for Hudson CLI.

Implementations:

CallableWhitelist

jenkins.security.s2m.CallableWhitelist

Used on the master to selectively allow specific Callable s to execute on the master even when those Callable s do not have proper Role declarations from its Callable#checkRoles(RoleChecker) method.

Implementations:

CaptchaSupport

hudson.security.captcha.CaptchaSupport

Extension point for adding Captcha Support to User Registration Page CaptchaSupport .

Implementations:

ChangeLogAnnotator

hudson.scm.ChangeLogAnnotator

Performs mark up on changelog messages to be displayed.

Implementations:

ChannelConfigurator

jenkins.security.ChannelConfigurator

Intercepts the new creation of Channel and tweak its configuration.

Implementations:

CliTransportAuthenticator

hudson.cli.CliTransportAuthenticator

This extension point has no Javadoc documentation.

Implementations:

(no known implementations)

Cloud

hudson.slaves.Cloud

Creates Node s to dynamically expand/shrink the agents attached to Hudson.

Implementations:

CloudProvisioningListener

hudson.slaves.CloudProvisioningListener

Allows extensions to be notified of events in any Cloud and to prevent provisioning from a Cloud .

Implementations:

ComputerConnector

hudson.slaves.ComputerConnector

Factory of ComputerLauncher .

Implementations:

ComputerLauncher

hudson.slaves.ComputerLauncher

Extension point to allow control over how Computer s are "launched", meaning how they get connected to their agent program.

Implementations:

ComputerListener

hudson.slaves.ComputerListener

Receives notifications about status changes of Computer s.

Implementations:

ComputerPanelBox

hudson.model.ComputerPanelBox

Adds box rendered in the computer side panel.

Implementations:

ComputerPinger

hudson.model.ComputerPinger

A way to see if a computer is reachable.

Implementations:

ConsoleAnnotationDescriptor

hudson.console.ConsoleAnnotationDescriptor

Descriptor for ConsoleNote .

Implementations:

ConsoleAnnotatorFactory

hudson.console.ConsoleAnnotatorFactory

Entry point to the ConsoleAnnotator extension point. This class creates a new instance of ConsoleAnnotator that starts a new console annotation session.

Implementations:

ConsoleLogFilter

hudson.console.ConsoleLogFilter

A hook to allow filtering of information that is written to the console log. Unlike ConsoleAnnotator and ConsoleNote , this class provides direct access to the underlying OutputStream so it's possible to suppress data, which isn't possible from the other interfaces. ( jenkinsdoc:ArgumentListBuilder#add(String, boolean)[] is a simpler way to suppress a single password.)

Implementations which are Serializable may be sent to an agent JVM for processing. In particular, this happens under JEP-210. In this case, the implementation should not assume that JenkinsJVM#isJenkinsJVM , and if generating ConsoleNote s will need to encode them on the master side first. </p>

Implementations:

ConsoleNote

hudson.console.ConsoleNote

Data that hangs off from a console output.

Implementations:

CrumbExclusion

hudson.security.csrf.CrumbExclusion

Allows plugins to define exceptions to the CSRF protection filter.

Implementations:

CrumbIssuer

hudson.security.csrf.CrumbIssuer

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.

Implementations:

CustomClassFilter

jenkins.security.CustomClassFilter

Allows extensions to adjust the behavior of ClassFilter#DEFAULT . Custom filters can be called frequently, and return values are uncached, so implementations should be fast.

Implementations:

DescriptorVisibilityFilter

hudson.model.DescriptorVisibilityFilter

Hides Descriptor s from users.

Implementations:

DownloadService.Downloadable

hudson.model.DownloadService.Downloadable

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

Implementations:

EnvVarsFilterGlobalRule

jenkins.tasks.filters.EnvVarsFilterGlobalRule

Environment variables filter rule that is configured globally for all jobs.

The job types can be filtered using jenkinsdoc:#isApplicable(Run, Object, Launcher)[] </p>

Implementations:

EnvVarsFilterLocalRule

jenkins.tasks.filters.EnvVarsFilterLocalRule

Environment variables filter rule that is specific to a job configuration, using script-specific variables, etc.

The job types can be filtered using EnvVarsFilterLocalRuleDescriptor#isApplicable(Class) </p>

Implementations:

EnvironmentContributor

hudson.model.EnvironmentContributor

Contributes environment variables to builds.

Implementations:

ExecutorListener

hudson.model.ExecutorListener

A listener for task related events from executors. A Computer#getRetentionStrategy or SlaveComputer#getLauncher may implement this interface. Or you may create an implementation as an extension (since TODO).

Implementations:

ExtensionFilter

jenkins.ExtensionFilter

Filters out ExtensionComponent s discovered by ExtensionFinder s, as if they were never discovered.

Implementations:

ExtensionFinder

hudson.ExtensionFinder

Discovers the implementations of an extension point.

Implementations:

FederatedLoginService

hudson.security.FederatedLoginService

Abstraction for a login mechanism through external authenticator/identity provider (instead of username/password.)

Implementations:

FilePath.FileCallableWrapperFactory

hudson.FilePath.FileCallableWrapperFactory

This extension point allows to contribute a wrapper around a fileCallable so that a plugin can "intercept" a call.

The #wrap(hudson.remoting.DelegatingCallable) method itself will be executed on the controller (and may collect contextual data if needed) and the returned wrapper will be executed on remote. </p>

Implementations:

FingerprintFacet

jenkins.model.FingerprintFacet

Plugin-specific additions to fingerprint information.

Implementations:

FingerprintStorage

jenkins.fingerprints.FingerprintStorage

Pluggable fingerprint storage API for fingerprints.

Implementations:

GlobalBuildDiscarderStrategy

jenkins.model.GlobalBuildDiscarderStrategy

Extension point for global background build discarders.

Implementations:

GlobalConfiguration

jenkins.model.GlobalConfiguration

Convenient base class for extensions that contributes to the system configuration page but nothing else, or to manage the global configuration of a plugin implementing several extension points.

Implementations:

GlobalConfigurationCategory

jenkins.model.GlobalConfigurationCategory

Grouping of related GlobalConfiguration s.

Implementations:

GlobalSettingsProvider

jenkins.mvn.GlobalSettingsProvider

This extension point has no Javadoc documentation.

Implementations:

jenkins.views.Header

Extension point that provides capabilities to render a specific header.

Implementations:

HttpSessionListener

jenkins.util.HttpSessionListener

javax.servlet.http.HttpSessionListener ExtensionPoint for Jenkins.

Allows plugins to listen to HttpSession lifecycle events. </p>

Implementations:

HudsonHomeDiskUsageMonitor.Solution

hudson.diagnosis.HudsonHomeDiskUsageMonitor.Solution

Extension point for suggesting solutions for full JENKINS_HOME.

Implementations:

(no known implementations)

IdStrategy

jenkins.model.IdStrategy

The strategy to use for manipulating converting names (e.g. user names, group names, etc) into ids.

Implementations:

InstallState

jenkins.install.InstallState

Jenkins install state.

Implementations:

InstallStateFilter

jenkins.install.InstallStateFilter

Allows plugging in to the lifecycle when determining InstallState from InstallUtil#getNextInstallState(InstallState)

Implementations:

(no known implementations)

InstanceIdentityProvider

jenkins.model.identity.InstanceIdentityProvider

A source of instance identity.

Implementations:

(no known implementations)

ItemCategory

jenkins.model.item_category.ItemCategory

A category for hudson.model.Item s.

Implementations:

ItemListener

hudson.model.listeners.ItemListener

Receives notifications about CRUD operations of Item .

Implementations:

JnlpAgentReceiver

jenkins.slaves.JnlpAgentReceiver

Receives incoming agents connecting through the likes of JnlpSlaveAgentProtocol4 or WebSocketAgents .

Implementations:

Job

hudson.model.Job

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

Implementations:

JobProperty

hudson.model.JobProperty

Extensible property of Job .

Implementations:

LabelAtomProperty

hudson.model.labels.LabelAtomProperty

Extensible property of LabelAtom .

Implementations:

LabelFinder

hudson.model.LabelFinder

Automatically adds labels to Node s.

Implementations:

LabelValidator

jenkins.model.labels.LabelValidator

Plugins may want to contribute additional restrictions on the use of specific labels for specific context items. This extension point allows such restrictions.

Implementations:

(no known implementations)

LauncherDecorator

hudson.LauncherDecorator

Decorates Launcher so that one can intercept executions of commands and alters the command being executed, such as doing this in fakeroot, sudo, pfexec, etc.

Implementations:

Lifecycle

hudson.lifecycle.Lifecycle

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

Implementations:

ListViewColumn

hudson.views.ListViewColumn

Extension point for adding a column to a table rendering of Item s, such as ListView .

Implementations:

LoadBalancer

hudson.model.LoadBalancer

Strategy that decides which Task gets run on which Executor .

Implementations:

LoadPredictor

hudson.model.queue.LoadPredictor

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

Implementations:

hudson.model.ManagementLink

Extension point to add icon to {@code http://server/hudson/manage} page.

Implementations:

MarkupFormatter

hudson.markup.MarkupFormatter

Generalization of a function that takes text with some markup and converts that to HTML. Such markup is often associated with Wiki.

Implementations:

MyViewsTabBar

hudson.views.MyViewsTabBar

Extension point for adding a MyViewsTabBar header to Projects MyViewsProperty .

Implementations:

Node

hudson.model.Node

Base type of Jenkins agents (although in practice, you probably extend Slave to define a new agent type).

Implementations:

NodeListener

jenkins.model.NodeListener

Listen to Node CRUD operations.

Implementations:

NodeMonitor

hudson.node_monitors.NodeMonitor

Extension point for managing and monitoring Node s.

Implementations:

NodeProperty

hudson.slaves.NodeProperty

Extensible property of Node .

Implementations:

NodeProvisioner.Strategy

hudson.slaves.NodeProvisioner.Strategy

Extension point for node provisioning strategies.

Implementations:

Notifier

hudson.tasks.Notifier

BuildStep s that run after the build is completed.

Implementations:

PageDecorator

hudson.model.PageDecorator

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

Implementations:

ParameterDefinition

hudson.model.ParameterDefinition

Defines a parameter for a build.

Implementations:

ParserConfigurator

hudson.util.io.ParserConfigurator

Configures XML parsers to be used for various XML parsing activities inside Jenkins.

Implementations:

(no known implementations)

PeriodicWork

hudson.model.PeriodicWork

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

Implementations:

PermissionAdder

hudson.security.PermissionAdder

Service which can add permissions for a given user to the configured authorization strategy. Useful e.g. to make the first user created in the system be automatically granted administer privilege.

Implementations:

PingFailureAnalyzer

jenkins.slaves.PingFailureAnalyzer

Get notified when a channel triggered a ping failure, but before the channel is killed.

Implementations:

(no known implementations)

PluginLocaleDrivenResourceProvider

jenkins.PluginLocaleDrivenResourceProvider

Contribute localizations for arbitrary resources from plugins.

Implementations:

PluginManagerStaplerOverride

hudson.PluginManagerStaplerOverride

Extension point for selectively overriding parts of the PluginManager views Anything extending this and registered with an @Extension can replace existing views and define new views.

Implementations:

(no known implementations)

PluginServletFilter

hudson.util.PluginServletFilter

Servlet Filter that chains multiple Filter s, provided by plugins

Implementations:

(no known implementations)

PluginStrategy

hudson.PluginStrategy

Pluggability point for how to create PluginWrapper .

Implementations:

ProcessKiller

hudson.util.ProcessKiller

Extension point that defines more elaborate way of killing processes, such as sudo or pfexec, for ProcessTree .

Implementations:

ProcessKillingVeto

hudson.util.ProcessKillingVeto

Allows extensions to veto killing processes. If at least one extension vetoes the killing of a process, it will not be killed. This can be useful to keep daemon processes alive. An example is mspdbsrv.exe used by Microsoft compilers.

Implementations:

ProjectNamingStrategy

jenkins.model.ProjectNamingStrategy

This ExtensionPoint allows to enforce the name of projects/jobs.

Implementations:

Queue.QueueDecisionHandler

hudson.model.Queue.QueueDecisionHandler

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

Implementations:

QueueItemAuthenticator

jenkins.security.QueueItemAuthenticator

Extension point to run hudson.model.Queue.Executable s under a specific identity for better access control. You must override either #authenticate2(hudson.model.Queue.Item) , or #authenticate2(hudson.model.Queue.Task) , or both.

Implementations:

QueueItemAuthenticatorProvider

jenkins.security.QueueItemAuthenticatorProvider

There are cases where a plugin need to provide a QueueItemAuthenticator that cannot be controlled or configured by the user. This extension point provides the mechanism whereby the a QueueItemAuthenticator can be provided either before or after those provided by QueueItemAuthenticatorConfiguration which will use Extension#ordinal() of {@code 100}

Implementations:

QueueListener

hudson.model.queue.QueueListener

Listener for events in Queue .

Implementations:

QueueSorter

hudson.model.queue.QueueSorter

Singleton extension point for sorting buildable items

Implementations:

QueueTaskDispatcher

hudson.model.queue.QueueTaskDispatcher

Vetos the execution of a task on a node

Implementations:

Recorder

hudson.tasks.Recorder

BuildStep s that run after the build is completed.

Implementations:

RepositoryBrowser

hudson.scm.RepositoryBrowser

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

Implementations:

RestartListener

hudson.model.RestartListener

Extension point that allows plugins to veto the restart.

Implementations:

RetentionStrategy

hudson.slaves.RetentionStrategy

Controls when to take Computer offline, bring it back online, or even to destroy it.

Implementations:

RootAction

hudson.model.RootAction

Marker interface for actions that are added to jenkins.model.Jenkins .

Implementations:

RoutingDecisionProvider

jenkins.security.stapler.RoutingDecisionProvider

This extension point has no Javadoc documentation.

Implementations:

Run

hudson.model.Run

A particular execution of Job .

Implementations:

Run.StatusSummarizer

hudson.model.Run.StatusSummarizer

Used to implement #getBuildStatusSummary .

Implementations:

RunListener

hudson.model.listeners.RunListener

Receives notifications about builds.

Implementations:

SCM

hudson.scm.SCM

Captures the configuration information in it.

Implementations:

SCMCheckoutStrategy

jenkins.scm.SCMCheckoutStrategy

Controls the check out behavior in AbstractBuild .

Implementations:

SCMDecisionHandler

jenkins.scm.SCMDecisionHandler

Extension point for various decisions about SCM operations for Item instances.

Implementations:

(no known implementations)

SCMListener

hudson.model.listeners.SCMListener

Receives notifications about SCM activities in Hudson.

Implementations:

SCMPollListener

hudson.model.listeners.SCMPollListener

A hook for listening to polling activities in Jenkins.

Implementations:

SaveableListener

hudson.model.listeners.SaveableListener

Receives notifications about save actions on Saveable objects in Hudson.

Implementations:

SearchFactory

hudson.search.SearchFactory

Creates a Search instance for a SearchableModelObject .

Implementations:

SecureRequester

jenkins.security.SecureRequester

An extension point for authorizing REST API access to an object where an unsafe result type would be produced. Both JSONP and XPath with primitive result sets are considered unsafe due to CSRF attacks. A default implementation allows requests if a deprecated system property is set, or if Jenkins is unsecured anyway, but plugins may offer implementations which authorize scripted clients, requests from inside a trusted domain, etc.

Implementations:

SecurityListener

jenkins.security.SecurityListener

Listener notified of various significant events related to security.

Implementations:

SecurityRealm

hudson.security.SecurityRealm

Pluggable security realm that connects external user database to Hudson.

Implementations:

SettingsProvider

jenkins.mvn.SettingsProvider

This extension point has no Javadoc documentation.

Implementations:

SimplePageDecorator

jenkins.model.SimplePageDecorator

Participates in the rendering of the login page

Implementations:

SlaveRestarter

jenkins.slaves.restarter.SlaveRestarter

Extension point to control how to restart an inbound agent when it loses the connection with the master.

Implementations:

SlaveSystemInfo

jenkins.slaves.systemInfo.SlaveSystemInfo

Extension point that contributes to the system information page of Computer .

Implementations:

SubTaskContributor

hudson.model.queue.SubTaskContributor

Externally contributes SubTask s to AbstractProject#getSubTasks() .

Implementations:

(no known implementations)

Telemetry

jenkins.telemetry.Telemetry

Extension point for collecting JEP-214 telemetry.

Implementations:

ToolInstallation

hudson.tools.ToolInstallation

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

Implementations:

ToolInstaller

hudson.tools.ToolInstaller

An object which can ensure that a generic ToolInstallation in fact exists on a node. The properties can be added to ToolInstallation using the InstallSourceProperty .

Implementations:

ToolLocationTranslator

hudson.tools.ToolLocationTranslator

This Jenkins-wide extension points can participate in determining the actual node-specific path of the ToolInstallation for the given Node .

Implementations:

ToolProperty

hudson.tools.ToolProperty

Extensible property of ToolInstallation .

Implementations:

TopLevelItem

hudson.model.TopLevelItem

Item that can be directly displayed under jenkins.model.Jenkins or other containers. (A "container" would be any ItemGroup {@code }, such as a folder of projects.) Ones that don't need to be under specific parent (say, unlike {@code MatrixConfiguration}), and thus can be freely moved, copied, etc.

Implementations:

TransientActionFactory

jenkins.model.TransientActionFactory

Allows you to add actions to any kind of object at once. but may specify a type such as TopLevelItem most of whose implementations are in fact Actionable

Implementations:

TransientBuildActionFactory

hudson.model.TransientBuildActionFactory

Extension point for inserting transient Action s into Run s.

Implementations:

TransientComputerActionFactory

hudson.model.TransientComputerActionFactory

Extension point for inserting transient hudson.model.Action s to hudson.model.Computer s.

To register your implementation, put hudson.Extension on your subtype. </p>

Implementations:

TransientFingerprintFacetFactory

jenkins.model.TransientFingerprintFacetFactory

This extension point has no Javadoc documentation.

Implementations:

(no known implementations)

TransientProjectActionFactory

hudson.model.TransientProjectActionFactory

Extension point for inserting transient Action s into AbstractProject s.

Implementations:

TransientUserActionFactory

hudson.model.TransientUserActionFactory

Extension point for inserting transient Action s into User s.

Implementations:

TransientViewActionFactory

hudson.model.TransientViewActionFactory

Extension point for adding transient Action s to View s.

Implementations:

Trigger

hudson.triggers.Trigger

Triggers a Build .

Implementations:

URLConnectionDecorator

hudson.URLConnectionDecorator

Decorates the connections that Jenkins open to access external resources.

Implementations:

UnprotectedRootAction

hudson.model.UnprotectedRootAction

RootAction s that are accessible to requests that do not have the READ permission on jenkins.model.Jenkins .

Implementations:

UpdateCenter.UpdateCenterConfiguration

hudson.model.UpdateCenter.UpdateCenterConfiguration

Strategy object for controlling the update center's behaviors.

Implementations:

(no known implementations)

User.CanonicalIdResolver

hudson.model.User.CanonicalIdResolver

Resolves User IDs by ID, full names or other strings.

This extension point may be useful to map SCM user names to Jenkins User IDs. Currently the extension point is used in jenkinsdoc:User#get(String, boolean, Map)[] . </p>

Implementations:

UserAvatarResolver

hudson.tasks.UserAvatarResolver

Infers avatar image URLs for users

Implementations:

UserNameResolver

hudson.tasks.UserNameResolver

Finds full name off the user when none is specified.

Implementations:

(no known implementations)

UserProperty

hudson.model.UserProperty

Extensible property of User .

Implementations:

View

hudson.model.View

Encapsulates the rendering of the list of TopLevelItem s that Jenkins owns.

Implementations:

ViewJobFilter

hudson.views.ViewJobFilter

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

Implementations:

ViewProperty

hudson.model.ViewProperty

Extensible property of View .

Implementations:

(no known implementations)

ViewsTabBar

hudson.views.ViewsTabBar

Extension point for adding a ViewsTabBar header to Projects ListView .

Implementations:

Widget

hudson.widgets.Widget

Box to be rendered in the side panel.

Implementations:

WorkspaceBrowser

hudson.model.WorkspaceBrowser

Allows to access a workspace as an alternative to online build node.

Primary use case is hudson.slaves.Cloud implementations that don't keep the agent online to browse workspace, but maintain a copy of node workspace on the controller. </p>

Implementations:

(no known implementations)

WorkspaceListener

hudson.model.WorkspaceListener

This extension point has no Javadoc documentation.

Implementations:

WorkspaceLocator

jenkins.slaves.WorkspaceLocator

Allow extensions to override workspace locations on given agents or projects.

Implementations: