Live Platform
  • Introduction
  • Release Notes
    • Live 3
      • 3.59.0
      • 3.58.0
      • 3.57.0
      • 3.56.0
      • 3.55.0
      • 3.54.0
      • 3.53.0
      • 3.52.0
      • 3.51.0
      • 3.50.0
      • 3.49.0
      • 3.48.0
      • 3.47.0
      • 3.46.0
      • 3.45.0
      • 3.44.0
      • 3.43.0
      • 3.42.0
      • 3.41.0
      • 3.40.0
      • 3.39.0
      • 3.38.0
      • 3.37.0
      • 3.36.0
      • 3.35.0
      • 3.34.0
      • 3.33.0
      • 3.32.0
      • 3.31.0
      • 3.30.0
      • 3.29.0
      • 3.28.0
      • 3.27.0
      • 3.26.0
      • 3.25.0
      • 3.24.0
      • 3.23.0
      • 3.22.0
      • 3.21.0
      • 3.20.0
      • 3.19.0
      • 3.18.0
      • 3.17.0
      • 3.16.0
      • 3.15.0
      • 3.14.0
      • 3.13.0
      • 3.12.0
      • 3.11.0
      • 3.10.0
      • 3.9.0
      • 3.8.0
      • 3.7.0
      • 3.6.0
      • 3.5.0
      • 3.4.0
      • 3.3.0
      • 3.2.0
      • 3.1.0
      • 3.0.0
    • Live 2
  • Articles
    • Creating an aggregation
    • Creating a pipe
  • Theoretical Background
    • Fundamentals
    • Key Advantages
  • Platform Architecture
    • Introduction
    • Queries
    • Glossary
  • Featured plugins
    • Annotations
    • Groovy support
    • Messenger
    • Microsoft Teams
    • MongoDB
    • MongoDB Timeseries
    • MongoDB Kit
    • Purge plugin
    • SQL
    • TCP Input
    • TimescaleDB
  • Data visualization
    • Pipes widgets
      • Temporal
      • Cartesian
      • Multi-value snapshot
      • Single-value snapshot
      • Tables
      • Heatmap
      • JSX Widgets
      • Lollipop
      • Histogram
      • State Timeline
      • Boxplot
    • Pipes modifiers on Pipes charts
  • Alerts and notifications
    • Pipes modifiers on rules
  • Pipes Queries
    • Introduction
    • Dynamic filters
    • Meta parameters
    • Reducer
      • Uniform compress
      • PIP
    • Storage Hints
    • Execution Context
    • Event flow modifiers
  • Developers
    • Plugins
    • Packages
    • Backend API
      • Lookup Tables
      • Extensions
      • Settings
      • Storage Providers
      • Web Services
      • Web Setup
      • Entity Audit
    • Web application
      • Services
        • Point service
        • Menu service
      • Browser Compatibility
      • Runtime modules
        • Core Javascript modules
        • Library modules
        • Adding modules to runtime
      • Localization (i18n)
      • Date formatting
      • Dashboard and Widgets
        • Widget API
        • Custom widget editors
        • Live Event Types
        • Live Widget Configuration
        • Live Widget Packaging
        • Widget Request Interceptors
      • React Contexts
        • Dashboard
        • Dashboard widget
      • Registering Home Page options
    • Python application
    • Subscribing to Live Events
  • Administration
    • Configuration
      • Home Page Customization
      • live.properties
    • Infrastructure Monitoring
    • Storage Monitoring
    • Queries Monitoring
    • Logs Monitoring
    • Data Purging
  • Features
    • Access Permission
    • Datasources
    • Export Dashboard
    • Partial Indexes
    • WebApp Metrics
    • Entity Audit
Powered by GitBook
On this page

Was this helpful?

  1. Developers
  2. Backend API

Web Setup

PreviousWeb ServicesNextEntity Audit

Last updated 4 years ago

Was this helpful?

Live supports a easy way to put both backend and frontend together in a single plugin.

For short, in backend maven project you could pick all web assets from something like webapp/target and made them available to webcontent folder inside the full plugin JAR as shown below.

<build>
    <resources>
        <resource>
            <directory>webapp/target</directory>
            <filtering>false</filtering>
            <targetPath>webcontent</targetPath>
        </resource>
        // ... other project resources you want
    </resources>
</build>

Live offers an util function to register a webcontent/bundle.js as part of Live main application. You just need the following setup code at plugin startup.

PluginUtils.defaultWebSetup(live);

Further information how to take advantage of Live to web development, please see the section.

Appendix: PluginUtils

PluginUtils.defaultWebSetup is a static method that uses Live.Web interface to add a new HTML tag at very end of the main body Live tag including a script tag to webcontent/bundle.js.

It's like magic, your web application just born!

public abstract class PluginUtils {
    public static final String CONTENT_DIR = "webcontent";


    public static void defaultWebSetup(Live live) throws Exception {
        ClassLoader loader = live.system().classloader();

        URL contentUrl = loader.getResource(CONTENT_DIR);
        if (contentUrl == null)
            return;

        live.web().addContent("", contentUrl);

        URL bundleUrl = loader.getResource(CONTENT_DIR + "/bundle.js");
        if (bundleUrl == null)
            return;

        String resolved = live.web().resolveContent("bundle.js");
        live.web().addTag(HtmlTag.Position.BODY_END, new HtmlTag.JsFile(resolved));
    }

}
Web Application