io.jenkins.blueocean

Class BluePageDecorator

java.lang.Object

io.jenkins.blueocean.BluePageDecorator

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

PageStatePreloadDecorator

public abstract class BluePageDecorator
extends Object
implements hudson.ExtensionPoint

Participates in the rendering of HTML pages for all pages of Hudson.

This class provides a few hooks to augument the HTML generation process of Hudson, across all the HTML pages that Hudson delivers.

For example, if you'd like to add a Google Analytics stat to Hudson, then you need to inject a small script fragment to all Hudson pages. This extension point provides a means to do that.

Life-cycle

Plugins that contribute this extension point should implement a new decorator and put Extension on the class.

Associated Views

header.jelly

This page is added right before the </head> tag. Convenient place for additional stylesheet, <meta> tags, etc.

 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler">
     <script>
         //your JS code
     </script>
 </j:jelly>
 

httpHeaders.jelly

For example, this httpHeader.jelly adds HTTP X-MY-HEADER

 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler">
    <st:header name="X-MY-HEADER" value="${it.someValue}"/>
 </j:jelly>

 

This is a generalization of the X-Jenkins header that aids auto-discovery. This fragment can write additional <st:header name="..." value="..." /> tags that go along with it.

Author:

Vivek Pandey

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
BluePageDecorator()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<BluePageDecorator>	all()

Methods inherited from class java.lang.Object

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

Constructor Detail

BluePageDecorator

public BluePageDecorator()

Method Detail

all

public static hudson.ExtensionList<BluePageDecorator> all()