Package jenkins.views

Class Header

java.lang.Object

jenkins.views.Header

All Implemented Interfaces:

ExtensionPoint

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.

Since:

2.323

See Also:

PartialHeader, FullHeader, JenkinsHeader

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
Header()

Method Summary

Modifier and Type	Method	Description
static Header	get()
boolean	isAvailable()	Checks if header is available
abstract boolean	isCompatible()	Checks API compatibility of the header
abstract boolean	isEnabled()	Checks if header is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header()

Method Detail

isAvailable

public boolean isAvailable()

Checks if header is available

Returns:

if header is available

isCompatible

public abstract boolean isCompatible()

Checks API compatibility of the header

Returns:

if header is compatible

isEnabled

public abstract boolean isEnabled()

Checks if header is enabled.

Returns:

if header is enabled

get

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static Header get()