Package org.apache.juneau.petstore.console

Class AboutRest

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.AboutRest

All Implemented Interfaces:

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

public class AboutRest
extends PetstoreConsolePage

About: what the petstore demonstrates, as prose cards, plus Juneau's REST utility beans shown against the Pet domain bean.

BeanDescription, Hyperlink and SeeOtherRoot are small beans meant for REST responses: OPTIONS-style introspection, navigational links and root-relative redirects.

Example:

// GET /console/about/beans/BeanDescription @RestGet(path="/beans/BeanDescription") public BeanDescription beanDescription() { return BeanDescription.of(Pet.class); }

<@card id="overview" title="About the petstore"><div class="jc-prose">...</div></@card>

See Also:

• Utility Beans
• juneau-petstore

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
AboutRest()

Method Summary

Modifier and Type	Method	Description
BeanDescription	beanDescription()
ResourceDescriptions	beans()	Lists the three utility-bean demos.
Hyperlink	hyperlink()
View	page(RestRequest req)	The About page.
SeeOtherRoot	seeOtherRoot()

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

AboutRest

public AboutRest()

Method Details

page

public View page(RestRequest req)

The About page.

Parameters:

req - The request; ?builder renders the builder twin.

Returns:

The page.

beans

public ResourceDescriptions beans()

Lists the three utility-bean demos.

Each link is servlet:/-relative, so the uri carries the beans/ segment.

Returns:

Descriptive links to the demos.

beanDescription

public BeanDescription beanDescription()

Returns:

A BeanDescription of Pet.

hyperlink

public Hyperlink hyperlink()

Returns:

A hyperlink back to this page.

seeOtherRoot

public SeeOtherRoot seeOtherRoot()

Returns:

A redirect to the servlet root.