io.jenkins.blueocean.commons

Class RESTFetchPreloader

java.lang.Object

org.apache.tools.ant.Target

org.apache.tools.ant.ExtensionPoint

io.jenkins.blueocean.commons.PageStatePreloader

io.jenkins.blueocean.commons.RESTFetchPreloader

All Implemented Interfaces:

org.apache.tools.ant.TaskContainer

public abstract class RESTFetchPreloader
extends PageStatePreloader

REST prefetch data preloader.

Pre-populates the page with REST data, allowing the client side Fetch module (see Fetch module in the @jenkins-cd/blueocean-core-js NPM packages) to avoid the REST API call overhead.

Create implementations of this class (and annotate with @Extension) for data that we know is going to be needed by the page.

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RESTFetchPreloader.FetchData

Constructor Summary

Constructors

Constructor and Description
RESTFetchPreloader()

Method Summary

Modifier and Type	Method and Description
protected abstract RESTFetchPreloader.FetchData	getFetchData(BlueUrlTokenizer blueUrl)
String	getStateJson() Get the state JSON to be set in the page's JavaScript blueocean global scope.
String	getStatePropertyPath() Get the JavaScript object graph path at shiwh the state is to be stored.

Methods inherited from class io.jenkins.blueocean.commons.PageStatePreloader

all

Methods inherited from class org.apache.tools.ant.ExtensionPoint

addDataType, addTask

Methods inherited from class org.apache.tools.ant.Target

addDependency, dependsOn, execute, getDependencies, getDescription, getIf, getLocation, getName, getProject, getTasks, getUnless, parseDepends, performTasks, setDepends, setDescription, setIf, setLocation, setName, setProject, setUnless, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTFetchPreloader

public RESTFetchPreloader()

Method Detail

getStatePropertyPath

public final String getStatePropertyPath()

Get the JavaScript object graph path at shiwh the state is to be stored.

Specified by:

getStatePropertyPath in class PageStatePreloader

Returns:

The JavaScript object graph path at shiwh the state is to be stored.

getStateJson

public final String getStateJson()

Get the state JSON to be set in the page's JavaScript blueocean global scope.

Specified by:

getStateJson in class PageStatePreloader

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.

getFetchData

protected abstract RESTFetchPreloader.FetchData getFetchData(@Nonnull
                                                             BlueUrlTokenizer blueUrl)