BasicRestObjectGroup (Apache Juneau 9.0.0)

java.lang.Object

org.apache.juneau.rest.servlet.RestObject

org.apache.juneau.rest.servlet.BasicRestObject

org.apache.juneau.rest.servlet.BasicRestObjectGroup

All Implemented Interfaces:: BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig, BasicGroupOperations, BasicRestOperations

public abstract class BasicRestObjectGroup extends BasicRestObject implements BasicGroupOperations

Identical to BasicRestServletGroup but doesn't extend from HttpServlet.

Meant as a base class for child REST resources in servlet containers or Spring Boot environments.

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 Classes

Constructor Summary

Constructors

Constructor

Description

BasicRestObjectGroup()
Method Summary

Modifier and Type

Method

Description

ChildResourceDescriptions

getChildren(RestRequest req)

[GET /] - Get child resources.

Methods inherited from class org.apache.juneau.rest.servlet.BasicRestObject
error, getFavIcon, getHtdoc, getStats, getSwagger

Methods inherited from class org.apache.juneau.rest.servlet.RestObject
doLog, getContext, getRequest, getResponse, log, log, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- BasicRestObjectGroup
  
  public BasicRestObjectGroup()
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.