Class BlueOceanUIProvider

  • All Implemented Interfaces:
    ExtensionPoint

    public abstract class BlueOceanUIProvider
    extends Object
    implements ExtensionPoint
    BlueOcean UI provider. Provides basic UI configuration.
    Author:
    Vivek Pandey
    • Constructor Detail

      • BlueOceanUIProvider

        public BlueOceanUIProvider()
    • Method Detail

      • getRootUrl

        @CheckForNull
        public abstract String getRootUrl()
        Root url where Jenkins is hosted. Must end with '/' suffix.
        Returns:
        it can return null if request is not made in context of HTTP request or root url is not configured.
      • getUrlBasePrefix

        @Nonnull
        public abstract String getUrlBasePrefix()
        Gives url base prefix where blueocean is hosted. e.g. "blue". It must not include '/' prefix or suffix.
        Returns:
        url base
      • getLandingPagePath

        @Nonnull
        public abstract String getLandingPagePath()
        Gives landing page path. This path is suffixes to getUrlBase(). e.g. if the landing page is at URL, http://localhost:8080/jenkins/blue/organization/org1/pipelines/ then this method should return "/organization/org1/pipelines/". Must have '/' prefix and suffix.
        Returns:
        landing page URL path