Extension Points defined in REST API for Blue Ocean Plugin

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

REST API for Blue Ocean Plugin

AdditionalAnalyticsProperties

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.analytics.AdditionalAnalyticsProperties]

Enhance a request with properties when tracking an analytics event

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.BrowserAndOperatingSystemAnalyticsProperties (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.ServerInfoAdditionalAnalyticsProperties (view on GitHub)

Analytics

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.analytics.Analytics]

Facade for reporting user analytics

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.AbstractAnalytics (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.KeenAnalyticsImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.NullAnalytics (view on GitHub)

ApiRoutable

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.ApiRoutable]

Marks the REST API endpoints that are exposed by jenkinsdoc:ApiHead]

Implementations:

Blue Ocean Pipeline Editor Plugin: io.blueocean.rest.pipeline.editor.PipelineMetadataService (view on GitHub)
i18n for Blue Ocean Plugin: io.jenkins.blueocean.i18n.BlueI18n (view on GitHub)
REST API for Blue Ocean Plugin: io.jenkins.blueocean.analytics.AnalyticsRoute (view on GitHub)
REST API for Blue Ocean Plugin: io.jenkins.blueocean.rest.model.BlueExtensionClassContainer (view on GitHub)
REST API for Blue Ocean Plugin: io.jenkins.blueocean.rest.model.BlueOrganizationContainer (view on GitHub)
REST API for Blue Ocean Plugin: io.jenkins.blueocean.rest.model.BlueUserContainer (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.ExtensionClassContainerImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.OrganizationContainerImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.UserContainerImpl (view on GitHub)

BlueExtensionClassContainer

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.model.BlueExtensionClassContainer]

Map representation of jenkinsdoc:BlueExtensionClass] es

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.ExtensionClassContainerImpl (view on GitHub)

BlueFavoriteResolver

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueFavoriteResolver]

Resolves favorite for a given model object jenkinsdoc:Item]

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.MultiBranchPipelineImpl.FavoriteResolverImpl (view on GitHub)

BlueIssueFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueIssueFactory]

This extension point has no Javadoc documentation.

Implementations:

GitHub Pipeline for Blue Ocean Plugin: io.jenkins.blueocean.blueocean_github_pipeline.GithubIssue.FactoryImpl (view on GitHub)
JIRA Integration for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.jira.BlueJiraIssue.FactoryImpl (view on GitHub)

BlueOceanConfigFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueOceanConfigFactory]

Blue Ocean configuration factory which allows different extensions to return configuration values.

Implementations:

Config API for Blue Ocean Plugin: io.jenkins.blueocean.config.BlueOceanConfigImpl.BlueOceanConfigFactoryImpl (view on GitHub)

BlueOceanUIProvider

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.BlueOceanUIProvider]

BlueOcean UI provider.

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.BlueOceanRootAction.BlueOceanUIProviderImpl (view on GitHub)

BlueOceanUrlMapper

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueOceanUrlMapper]

Maps Jenkins jenkinsdoc:ModelObject] to BlueOcean front end URL

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.BlueOceanUrlMapperImpl (view on GitHub)

BlueOceanUrlObjectFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueOceanUrlObjectFactory]

jenkinsdoc:hudson.ExtensionPoint] to provide jenkinsdoc:BlueOceanUrlObject] for Jenkins model object

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.BlueOceanUrlObjectFactoryImpl (view on GitHub)

BlueOrganizationContainer

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.model.BlueOrganizationContainer]

Container of BlueOcean jenkinsdoc:BlueOrganization] s

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.OrganizationContainerImpl (view on GitHub)

BluePipelineFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BluePipelineFactory]

Factory that gives instance of jenkinsdoc:BluePipeline]

Implementations:

GitHub Pipeline for Blue Ocean Plugin: io.jenkins.blueocean.blueocean_github_pipeline.GithubOrganizationFolder.OrganizationFolderFactoryImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.BranchImpl.PipelineFactoryImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.MatrixProjectImpl.PipelineFactoryImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.MultiBranchPipelineImpl.PipelineFactoryImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.OrganizationFolderPipelineImpl.OrganizationFolderFactory (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.PipelineImpl.PipelineFactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.AbstractPipelineImpl.PipelineFactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.FreeStylePipeline.FactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.PipelineFolderImpl.PipelineFactoryImpl (view on GitHub)

BlueRunFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueRunFactory]

Factory that gives instance of jenkinsdoc:BlueRun]

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.PipelineRunImpl.FactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.DefaultRunImpl.FactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.FreeStyleRunImpl.FactoryImpl (view on GitHub)

BlueTestResultFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueTestResultFactory]

This extension point has no Javadoc documentation.

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.junit.BlueJUnitTestResult.FactoryImpl (view on GitHub)
Robot Framework Plugin: hudson.plugins.robot.blueocean.BlueRobotTestResult.FactoryImpl (view on GitHub)

BlueTrendFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.BlueTrendFactory]

Allows extensions to attach jenkinsdoc:BlueTrend] data to a jenkinsdoc:BluePipeline] for reports and visualization.

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.StageDurationTrend.FactoryImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.junit.BlueJUnitTrend.FactoryImpl (view on GitHub)

BlueUserContainer

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.model.BlueUserContainer]

User API.

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.UserContainerImpl (view on GitHub)

LinkResolver

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.hal.LinkResolver]

This extension point has no Javadoc documentation.

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.LinkResolverImpl (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.LinkResolverImpl (view on GitHub)

OmniSearch

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.OmniSearch]

Extension point to contribute the search capability

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.credential.CredentialSearch (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.PipelineSearch (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.RunSearch (view on GitHub)
REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.rest.UserSearch (view on GitHub)

OrganizationFactory

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.factory.organization.OrganizationFactory]

Maps BlueOcean organization and jenkinsdoc:ItemGroup] s.

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.OrganizationFactoryImpl (view on GitHub)

OrganizationRoute

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.OrganizationRoute]

Route contributing to jenkinsdoc:io.jenkins.blueocean.rest.model.BlueOrganization] : url path /organization/:id/:organizationRoute.urlName()

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.credential.CredentialContainer (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.scm.ScmContainer (view on GitHub)

RootRoutable

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.RootRoutable]

Additional jenkinsdoc:Routable] s that augment jenkinsdoc:BlueOceanUIProvider=getUrlBasePrefix()] root object.

Implementations:

Git Pipeline for Blue Ocean Plugin: io.jenkins.blueocean.blueocean_git_pipeline.RepositoryCloneProgressEndpoint (view on GitHub)
REST API for Blue Ocean Plugin: io.jenkins.blueocean.rest.ApiHead (view on GitHub)

UserRoute

jenkinsdoc:blueocean-rest:io.jenkins.blueocean.rest.UserRoute]

Route contributing to jenkinsdoc:io.jenkins.blueocean.rest.model.BlueUser] : url path /organization/:id/users/:user/:userRoute.urlName()

Implementations:

Git Pipeline for Blue Ocean Plugin: io.jenkins.blueocean.ssh.UserPublicKeyRoute (view on GitHub)