Package org.apache.juneau.rest.servlet

Class BasicRestServletGroup

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.servlet.RestServlet

org.apache.juneau.rest.servlet.BasicRestServlet

org.apache.juneau.rest.servlet.BasicRestServletGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

DtoExamples, RootResources, SampleRootResource

public abstract class BasicRestServletGroup
extends BasicRestServlet
implements BasicGroupOperations

Specialized subclass of BasicRestServlet for showing "group" pages.

Meant as a base class for top-level REST resources in servlet containers.

Provides support for JSON, XML, HTML, URL-Encoding, UON, XML, OpenAPI, and MessagePack. See BasicUniversalConfig for details.

Implements the basic REST endpoints defined in BasicRestOperations and BasicGroupOperations.

Children are attached to this resource using the @Rest(children) annotation.

See Also:

• @Rest-Annotated Class Basics

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
BasicRestServletGroup()

Method Summary

Modifier and Type	Method	Description
ChildResourceDescriptions	getChildren(RestRequest req)	[GET /] - Get child resources.

Methods inherited from class org.apache.juneau.rest.servlet.BasicRestServlet

error, getFavIcon, getHtdoc, getStats, getSwagger

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

destroy, doLog, getContext, getPath, getRequest, getResponse, 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

BasicRestServletGroup

public BasicRestServletGroup()

Method Details

getChildren

public ChildResourceDescriptions getChildren(RestRequest req)

Description copied from interface: BasicGroupOperations

[GET /] - Get child resources.

Returns a bean that lists and allows navigation to child resources.

Specified by:

getChildren in interface BasicGroupOperations

Parameters:

req - The HTTP request.

Returns:

The bean containing links to the child resources.