Package jenkins.views

Class Header

  • All Implemented Interfaces:
    Direct Known Subclasses:
    FullHeader, PartialHeader

    public abstract class Header
    extends Object
    implements ExtensionPoint
    Extension point that provides capabilities to render a specific header. Extend PartialHeader or FullHeader depending on the use case. The default Jenkins header is provided as an implementation of a FullHeader named JenkinsHeader. The first header located will be used, set the ordinal field on Extension to have a higher priority. The header content will be injected inside the pageHeader.jelly, based on the header retrieved by the get() method. That header content will be provided inside a resource called headerContent.jelly. It performs a full replacement of the header.
    See Also:
    PartialHeader, FullHeader, JenkinsHeader
    • Constructor Detail

      • Header

        public Header()
    • Method Detail

      • isAvailable

        public boolean isAvailable()
        Checks if header is available
        if header is available
      • isCompatible

        public abstract boolean isCompatible()
        Checks API compatibility of the header
        if header is compatible
      • isEnabled

        public abstract boolean isEnabled()
        Checks if header is enabled.
        if header is enabled
      • get

        public static Header get()