Class 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)
    • Constructor Detail

      • DisplayURLProvider

        public DisplayURLProvider()
    • Method Detail

      • 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()