Package org.apache.juneau.console.freemarker

Class ToolkitPackRegistry

java.lang.Object

org.apache.juneau.console.freemarker.ToolkitPackRegistry

public final class ToolkitPackRegistry
extends Object

Registry of named toolkit packs for the <@page toolkit=...> directive and for the packs cards require.

Built-in packs:

• "jquery", "datatables" and "datatables-buttons" (ToolkitPack.Kind.VENDOR) — WebJars, resolved through WEBJAR_RESOLVER to the host's WebJarsMixin mount. "datatables" depends on "jquery"; "datatables-buttons" on "datatables".
• "datatables-glue" (ToolkitPack.Kind.VENDOR) — the first-party glue (ViewsMixin.DATATABLES_JS_PATH, served by DataTablesMixin); depends on "datatables". Every <@card type="datatables"> requires it.
• "views" (ToolkitPack.Kind.RUNTIME) — the views runtime. JS order is a contract: bus (first), renders, icons, search, pagestate, urlstate, ribbon, views, config, regions, terminal-view, helpers. juneau-urlstate.js must precede juneau-views.js / juneau-config.js.
• "calendar" (ToolkitPack.Kind.RUNTIME) — the juneau-calendar.* runtime from juneau-console-widgets, resolved through WIDGETS_RESOLVER.
• "xterm" (ToolkitPack.Kind.VENDOR) — the xterm.js WebJar (library and stylesheet), resolved through WEBJAR_RESOLVER.
• "terminal" (ToolkitPack.Kind.RUNTIME) — the juneau-terminal.* runtime from juneau-terminal-region, resolved through TerminalMixin.terminalAssetUrl(RestRequest, String); depends on "views" and "xterm". Every <@card type="terminal"> requires it, so a page with a terminal card needs no toolkit=.
• "charts" (ToolkitPack.Kind.RUNTIME) — juneau-charts.js from juneau-console, resolved through ConsoleChromeMixin.consoleAssetUrl(RestRequest, String); depends on "echarts" and "data". Every <@card type="chart"> requires it.
• "joblog" (ToolkitPack.Kind.RUNTIME) — juneau-joblog.js from juneau-console; no dependencies. Every <@card type="job-log"> requires it.
• "echarts" (ToolkitPack.Kind.VENDOR) — the ECharts WebJar (ECHARTS_JS_ASSET), optional on the classpath: a missing jar is E-70 at startup when the app opts in (ConsoleFreemarkerMixin.Builder.requirePacks), else at the first chart page.
• "echarts-gl" (ToolkitPack.Kind.VENDOR) — the echarts-gl WebJar; depends on "echarts"; a page opts in with toolkit("echarts-gl").
• "data" (ToolkitPack.Kind.RUNTIME) — juneau-data.js (JuneauViews.data); depends on "views".

resolve(List, RestRequest, List, String) expands the requested packs depth-first over ToolkitPack.dependsOn() (each pack after its dependencies, siblings in request order, each pack once), skips provided packs (their dependencies still load), skips an asset whose file name the page already loads through init= or css= (with a WARN), and splits the result by kind. validate() checks the static graph: unknown dependsOn names, cycles, and a VENDOR pack depending on a RUNTIME pack.

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolkitPackRegistry.AssetUrlResolver	Resolves an asset path to an absolute, cache-busted URL against the in-flight request.
static final record	ToolkitPackRegistry.Resolved	Resolved absolute URLs, split by pack kind.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ECHARTS_GL_JS_ASSET	The echarts-gl library asset id (path unverified against the WebJar; no module depends on it).
static final String	ECHARTS_JS_ASSET	The ECharts library asset id, for WEBJAR_RESOLVER.
static final String	PACK_CALENDAR	The built-in "calendar" pack: the already-shipping juneau-calendar.* runtime from juneau-console-widgets.
static final String	PACK_CHARTS	The built-in chart-card runtime pack (juneau-charts.js); depends on "echarts" and "data".
static final String	PACK_DASHBOARD	Dashboard chrome (PageSpec.dashboard); added by the builder, never needed in toolkit(...).
static final String	PACK_DATA	The built-in DataRegistry runtime pack (juneau-data.js); depends on "views".
static final String	PACK_DATATABLES	The built-in DataTables WebJar pack (library plus default styling CSS).
static final String	PACK_DATATABLES_BUTTONS	The built-in DataTables Buttons WebJar pack (copy and CSV export, no JSZip or pdfmake).
static final String	PACK_DATATABLES_GLUE	The built-in pack holding the first-party DataTables glue.
static final String	PACK_ECHARTS	The built-in ECharts WebJar pack (org.webjars.npm:echarts, optional on the classpath).
static final String	PACK_ECHARTS_GL	The built-in echarts-gl WebJar pack; depends on "echarts"; never required by a card type.
static final String	PACK_JOBLOG	The built-in job-log card runtime pack (juneau-joblog.js); no dependencies.
static final String	PACK_JQUERY	The built-in jQuery WebJar pack.
static final String	PACK_TERMINAL	The built-in terminal runtime pack; depends on "views" and "xterm".
static final String	PACK_VIEWS	The built-in views runtime pack.
static final String	PACK_XTERM	The built-in xterm.js WebJar pack (library plus stylesheet).
static final ToolkitPackRegistry.AssetUrlResolver	VIEWS_RESOLVER	The default resolver: ViewsMixin.viewAssetUrl(RestRequest, String).
static final ToolkitPackRegistry.AssetUrlResolver	WEBJAR_RESOLVER	The WebJar resolver: paths are WebJarResolver.asset(String, String, String) ids.
static final ToolkitPackRegistry.AssetUrlResolver	WIDGETS_RESOLVER	The "calendar" pack resolver: WidgetsMixin.widgetAssetUrl(RestRequest, String).

Constructor Summary

Constructors

Constructor	Description
ToolkitPackRegistry()	Constructs the registry with the built-in packs installed.

Method Summary

Modifier and Type	Method	Description
ToolkitPackRegistry	checkWebJars(Collection<String> roots)	Probes, at startup, every WebJar the given packs reach: each non-provided VENDOR pack resolved through WEBJAR_RESOLVER.
boolean	contains(String name)
ToolkitPackRegistry	provide(Collection<String> names)	Marks packs as already loaded by the app: they contribute no URLs, but their dependencies still load.
boolean	reaches(String root, String target)
void	register(ToolkitPack pack)	Registers a pack, replacing any pack with the same name (all of its fields, including dependsOn).
void	requireKnown(Collection<String> names, String source)	Checks that every name is a registered pack.
ToolkitPackRegistry.Resolved	resolve(List<String> names, RestRequest req, List<String> pageUrls, String template)	Resolves the root packs and their dependencies to absolute URLs, split by kind.
ToolkitPackRegistry	validate()	Checks the static graph: every dependsOn and provided name is registered, there is no cycle, and no VENDOR pack depends on a RUNTIME pack.

Methods inherited from class java.lang.Object

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

Field Details

PACK_VIEWS

public static final String PACK_VIEWS

The built-in views runtime pack.

See Also:

• Constant Field Values

PACK_CALENDAR

public static final String PACK_CALENDAR

The built-in "calendar" pack: the already-shipping juneau-calendar.* runtime from juneau-console-widgets. Never inferred from type="calendar"; a calendar page lists it explicitly (e.g. toolkit="views,calendar").

See Also:

• Constant Field Values

PACK_JQUERY

public static final String PACK_JQUERY

The built-in jQuery WebJar pack.

See Also:

• Constant Field Values

PACK_DATATABLES

public static final String PACK_DATATABLES

The built-in DataTables WebJar pack (library plus default styling CSS).

See Also:

• Constant Field Values

PACK_DATATABLES_GLUE

public static final String PACK_DATATABLES_GLUE

The built-in pack holding the first-party DataTables glue.

See Also:

• Constant Field Values

PACK_DATATABLES_BUTTONS

public static final String PACK_DATATABLES_BUTTONS

The built-in DataTables Buttons WebJar pack (copy and CSV export, no JSZip or pdfmake).

See Also:

• Constant Field Values

PACK_XTERM

public static final String PACK_XTERM

The built-in xterm.js WebJar pack (library plus stylesheet).

See Also:

• Constant Field Values

PACK_TERMINAL

public static final String PACK_TERMINAL

The built-in terminal runtime pack; depends on "views" and "xterm".

See Also:

• Constant Field Values

PACK_CHARTS

public static final String PACK_CHARTS

The built-in chart-card runtime pack (juneau-charts.js); depends on "echarts" and "data".

See Also:

• Constant Field Values

PACK_JOBLOG

public static final String PACK_JOBLOG

The built-in job-log card runtime pack (juneau-joblog.js); no dependencies.

See Also:

• Constant Field Values

PACK_DASHBOARD

public static final String PACK_DASHBOARD

Dashboard chrome (PageSpec.dashboard); added by the builder, never needed in toolkit(...).

See Also:

• Constant Field Values

PACK_ECHARTS

public static final String PACK_ECHARTS

The built-in ECharts WebJar pack (org.webjars.npm:echarts, optional on the classpath).

See Also:

• Constant Field Values

PACK_ECHARTS_GL

public static final String PACK_ECHARTS_GL

The built-in echarts-gl WebJar pack; depends on "echarts"; never required by a card type.

See Also:

• Constant Field Values

PACK_DATA

public static final String PACK_DATA

The built-in DataRegistry runtime pack (juneau-data.js); depends on "views".

See Also:

• Constant Field Values

ECHARTS_JS_ASSET

public static final String ECHARTS_JS_ASSET

The ECharts library asset id, for WEBJAR_RESOLVER.

ECHARTS_GL_JS_ASSET

public static final String ECHARTS_GL_JS_ASSET

The echarts-gl library asset id (path unverified against the WebJar; no module depends on it).

VIEWS_RESOLVER

public static final ToolkitPackRegistry.AssetUrlResolver VIEWS_RESOLVER

The default resolver: ViewsMixin.viewAssetUrl(RestRequest, String).

WIDGETS_RESOLVER

public static final ToolkitPackRegistry.AssetUrlResolver WIDGETS_RESOLVER

The "calendar" pack resolver: WidgetsMixin.widgetAssetUrl(RestRequest, String).

WEBJAR_RESOLVER

public static final ToolkitPackRegistry.AssetUrlResolver WEBJAR_RESOLVER

The WebJar resolver: paths are WebJarResolver.asset(String, String, String) ids.

Constructor Details

ToolkitPackRegistry

public ToolkitPackRegistry()

Constructs the registry with the built-in packs installed.

Method Details

register

public void register(ToolkitPack pack)

Registers a pack, replacing any pack with the same name (all of its fields, including dependsOn).

Parameters:

pack - The pack.

provide

public ToolkitPackRegistry provide(Collection<String> names)

Marks packs as already loaded by the app: they contribute no URLs, but their dependencies still load.

Parameters:

names - The pack names.

Returns:

This object.

contains

public boolean contains(String name)

Parameters:

name - A pack name.

Returns:

true if a pack with that name is registered.

validate

public ToolkitPackRegistry validate()

Checks the static graph: every dependsOn and provided name is registered, there is no cycle, and no VENDOR pack depends on a RUNTIME pack.

Returns:

This object.

Throws:

IllegalArgumentException - On the first problem found.

requireKnown

public void requireKnown(Collection<String> names,
 String source)

Checks that every name is a registered pack.

Parameters:

names - The pack names.

source - Where the names came from, for the message (e.g. <@page toolkit=>).

Throws:

IllegalArgumentException - If a name is unknown.

reaches

public boolean reaches(String root,
 String target)

Parameters:

root - A registered pack name.

target - A pack name.

Returns:

true if target is root or one of its transitive dependsOn.

checkWebJars

public ToolkitPackRegistry checkWebJars(Collection<String> roots)

Probes, at startup, every WebJar the given packs reach: each non-provided VENDOR pack resolved through WEBJAR_RESOLVER.

Parameters:

roots - Root pack names; empty probes nothing.

Returns:

This object.

Throws:

IllegalStateException - E-70 when a WebJar or its file is not on the classpath.

resolve

public ToolkitPackRegistry.Resolved resolve(List<String> names,
 RestRequest req,
 List<String> pageUrls,
 String template)

Resolves the root packs and their dependencies to absolute URLs, split by kind.

Parameters:

names - The root pack names, in order. Empty or null = nothing (no request needed).

req - The in-flight request.

pageUrls - The page's own init= and css= URLs; a pack asset with the same file name is skipped with a WARN.

template - The page template name, for the WARN.

Returns:

The resolved URLs.

Throws:

IllegalArgumentException - On an unknown pack or a cycle.

IllegalStateException - If the request is missing or a resolver fails (e.g. a WebJar isn't on the classpath).