Package org.jenkinsci.plugins.displayurlapi

Class DisplayURLProvider

java.lang.Object

org.jenkinsci.plugins.displayurlapi.DisplayURLProvider

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

ClassicDisplayURLProvider

public abstract class DisplayURLProvider
extends Object
implements ExtensionPoint

Generates URLs for well known UI locations for use in notifications (e.g. mailer, HipChat, Slack, IRC, etc) Extensible to allow plugins to override common URLs (e.g. Blue Ocean or another future secondary UI)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
DisplayURLProvider()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<DisplayURLProvider>	all()	Returns all the DisplayURLProvider implementations.
static DisplayURLProvider	get()	Returns the DisplayURLProvider to use for generating links to be given to users.
String	getArtifactsURL(Run<?,?> run)	Fully qualified URL for a page that displays artifacts for a Run.
abstract String	getChangesURL(Run<?,?> run)	Fully qualified URL for a page that displays changes for a project.
static DisplayURLProvider	getDefault()
String	getDisplayName()	Display name of this provider e.g.
abstract String	getJobURL(Job<?,?> job)	Fully qualified URL for a Jobs home
String	getName()	Name of provider to be used as an id.
static DisplayURLProvider	getPreferredProvider()
String	getRoot()	Fully qualified URL for the Root display URL
abstract String	getRunURL(Run<?,?> run)	Fully qualified URL for a Run
abstract String	getTestsURL(Run<?,?> run)	Fully qualified URL for a page that displays tests for a Run.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayURLProvider

public DisplayURLProvider()

Method Detail

get

public static DisplayURLProvider get()

Returns the DisplayURLProvider to use for generating links to be given to users.

Returns:

DisplayURLProvider

all

public static ExtensionList<DisplayURLProvider> all()

Returns all the DisplayURLProvider implementations.

Returns:

all the DisplayURLProvider implementations.

getDefault

public static DisplayURLProvider getDefault()

getRoot

@NonNull
public String getRoot()

Fully qualified URL for the Root display URL

getDisplayName

@NonNull
public String getDisplayName()

Display name of this provider e.g. "Jenkins Classic", "Blue Ocean", etc

getName

@NonNull
public String getName()

Name of provider to be used as an id. Do not use i18n

getRunURL

@NonNull
public abstract String getRunURL(Run<?,?> run)

Fully qualified URL for a Run

getArtifactsURL

@NonNull
public String getArtifactsURL(Run<?,?> run)

Fully qualified URL for a page that displays artifacts for a Run.

getChangesURL

@NonNull
public abstract String getChangesURL(Run<?,?> run)

Fully qualified URL for a page that displays changes for a project.

getTestsURL

public abstract String getTestsURL(Run<?,?> run)

Fully qualified URL for a page that displays tests for a Run.

getJobURL

@NonNull
public abstract String getJobURL(Job<?,?> job)

Fully qualified URL for a Jobs home

getPreferredProvider

@Nullable
public static DisplayURLProvider getPreferredProvider()