Class 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
    • Constructor Detail

      • PageStatePreloader

        public PageStatePreloader()
    • 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.