Package io.jenkins.blueocean.commons
Class PageStatePreloader
- java.lang.Object
-
- io.jenkins.blueocean.commons.PageStatePreloader
-
- All Implemented Interfaces:
ExtensionPoint
public abstract class PageStatePreloader extends Object implements ExtensionPoint
Page state "preloader" extension point.Allows the loading page's JavaScript blueocean global scope to be pre-populated with data that we know the page is going to need, thereby providing a mechanism for eliminating the request overhead for that data.
- Author:
- tom.fennelly@gmail.com
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description PageStatePreloader()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static ExtensionList<PageStatePreloader>
all()
abstract String
getStateJson()
Get the state JSON to be set in the page's JavaScript blueocean global scope.abstract String
getStatePropertyPath()
Get the JavaScript object graph path at which the state is to be stored.
-
-
-
Method Detail
-
getStatePropertyPath
@NonNull public abstract String getStatePropertyPath()
Get the JavaScript object graph path at which the state is to be stored.- Returns:
- The JavaScript object graph path at which the state is to be stored.
-
getStateJson
@CheckForNull public abstract String getStateJson()
Get the state JSON to be set in the page's JavaScript blueocean global scope.- Returns:
- The state JSON to be set in the page's JavaScript blueocean global
scope, or
null
if no data is to be set of this page.
-
all
public static ExtensionList<PageStatePreloader> all()
-
-