Package org.apache.juneau.petstore.console

Class PetstoreConsolePage

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.server.servlet.RestServlet

org.apache.juneau.rest.server.servlet.BasicRestServlet

org.apache.juneau.petstore.console.PetstoreConsolePage

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig

Direct Known Subclasses:

AboutRest, AuditRest, ChangesRest, ChartsRest, CustomCardsRest, DashboardRest, DataRest, DevRest, FlavorsRest, FreemarkerFlavorRest, HtmlFlavorRest, JobsRest, MustacheFlavorRest, OpsRest, OrdersRest, PetsRest, PetstoreConsoleResource, SecureApiRest, SecureRest, StoreRest, ThemesRest, UsersRest

public abstract class PetstoreConsolePage
extends BasicRestServlet

Base class for every petstore console page resource: registers the console FreeMarker mixin with base.ftlh as chrome, and injects the shared PetStore.

Children don't inherit the parent's mixins, so every page class extends this one instead of re-declaring the mixin, which E-B12 would reject.

The views and DataTables toolkit packs link their assets page-relative (e.g. /console/store/juneau-views.js), so every page also composes ViewsMixin and DataTablesMixin to serve them from its own mount.

Example:

@Rest(path="/ops/audit") public class AuditRest extends PetstoreConsolePage { @RestGet(path="/") public View page() { return FreemarkerView.of("audit.ftlh"); } }

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestServlet

RestServlet.Builder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>, RestServlet.DefaultBuilder<R extends RestServlet>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAGE_HEADER	Response header naming the render path of a builder-twin page, so a twin test can tell the two paths apart.
static final String	TEMPLATES	Classpath folder holding the console templates.

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
PetstoreConsolePage()

Method Summary

Modifier and Type	Method	Description
static boolean	builder(RestRequest req)	Whether this request asks for the builder twin of a page (?builder, with or without a value).
FreemarkerMixin	freemarker()	The console FreeMarker mixin: petstore templates, base.ftlh chrome, assetUrl(..) over this package's bundled scripts, and the InventoryGaugeCardType custom card type.
protected PetStore	store()
static View	twin(RestRequest req, PageSpec spec)	Renders a builder-twin page, marked with PAGE_HEADER.

Methods inherited from class org.apache.juneau.rest.server.servlet.RestServlet

builder, createAuthenticator, destroy, doLog, getContext, getPath, getPaths, getRequest, getResponse, getRestBuilder, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, isSensitiveHeader, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

TEMPLATES

public static final String TEMPLATES

Classpath folder holding the console templates.

See Also:

• Constant Field Values

PAGE_HEADER

public static final String PAGE_HEADER

Response header naming the render path of a builder-twin page, so a twin test can tell the two paths apart.

See Also:

• Constant Field Values

Constructor Details

PetstoreConsolePage

public PetstoreConsolePage()

Method Details

builder

public static boolean builder(RestRequest req)

Whether this request asks for the builder twin of a page (?builder, with or without a value).

Parameters:

req - The request.

Returns:

true if the page should render from its PageSpec.

twin

public static View twin(RestRequest req,
 PageSpec spec)

Renders a builder-twin page, marked with PAGE_HEADER.

Parameters:

req - The request.

spec - The page spec.

Returns:

The view.

freemarker

public FreemarkerMixin freemarker()

The console FreeMarker mixin: petstore templates, base.ftlh chrome, assetUrl(..) over this package's bundled scripts, and the InventoryGaugeCardType custom card type.

Returns:

The mixin.

store

protected PetStore store()

Returns:

The shared store.

Throws:

IllegalStateException - If no PetStore @Bean was wired into the host.