Package org.apache.juneau.petstore.console

Class PetstoreConsoleResource

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

org.apache.juneau.petstore.console.PetstoreConsoleResource

All Implemented Interfaces:

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

public class PetstoreConsoleResource
extends PetstoreConsolePage

Root of the petstore admin console, mounted at /console beside the /petstore API and sharing its PetStore.

Every page renders through base.ftlh (the <@console> chrome and nav tree).

Example:

// Mount it in a runner beside the API; both see the same @Bean PetStore. @Rest(children={PetStoreResource.class, PetstoreConsoleResource.class}) public class RootResources extends BasicRestServletGroup { @Bean public PetStore petStore() { return PetstoreSeed.create().populate(new PetStore()); } }

<#-- base.ftlh --> <@console brand="Juneau Petstore"> <@navigation><@node id="store" label="Store" href="/console/store"/> ... </@navigation> <@main/> </@console>

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 inherited from class org.apache.juneau.petstore.console.PetstoreConsolePage

PAGE_HEADER, TEMPLATES

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
PetstoreConsoleResource()

Method Summary

Modifier and Type	Method	Description
SeeOther	index(RestRequest req)	GET /console redirects to the store dashboard.
void	script(RestResponse res)	Serves petstore.js, the shared page script base.ftlh loads after the toolkit on every page.

Methods inherited from class org.apache.juneau.petstore.console.PetstoreConsolePage

builder, freemarker, store, twin

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

Constructor Details

PetstoreConsoleResource

public PetstoreConsoleResource()

Method Details

index

public SeeOther index(RestRequest req)

GET /console redirects to the store dashboard.

Parameters:

req - The request.

Returns:

A 303 to /console/store.

script

public void script(RestResponse res)
            throws IOException

Serves petstore.js, the shared page script base.ftlh loads after the toolkit on every page.

Parameters:

res - The response.

Throws:

IOException - If the bundled script can't be read.