Package org.apache.juneau.rest.server.servlet

Class BasicRestResourceGroup

java.lang.Object

org.apache.juneau.rest.server.servlet.RestResource

org.apache.juneau.rest.server.servlet.BasicRestResource

org.apache.juneau.rest.server.servlet.BasicRestResourceGroup

All Implemented Interfaces:

BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig

public abstract class BasicRestResourceGroup
extends BasicRestResource

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.

Adds the group-navigation endpoint (GET /) by composing NavigationMixin via @Rest(mixins=...) on top of the residual op-mixins inherited from BasicRestResource. The navigation op lives on the NavigationMixin sub-context (backed by RestMixin.getHostContext()) but renders with the host's @HtmlDocConfig page decoration — mixin sub-contexts inherit the host's class-level @HtmlDocConfig (and other class-level config), so the navigation page matches the host's other endpoints.

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

Dynamic children:

Additional child resources can be registered or unregistered at runtime via addChild(Class) / removeChild(String) (and overloads). This is particularly useful in test fixtures where a single group resource is mounted once and individual tests plug in their own @Rest resources without restarting the container.

See Also:

• @Rest-Annotated Class

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
BasicRestResourceGroup()

Method Summary

Modifier and Type	Method	Description
RestContext	addChild(Class<?> resourceClass)	Dynamically registers a child REST resource by class.
RestContext	addChild(Object resource)	Dynamically registers a pre-instantiated child REST resource.
RestContext	addChild(String path, Object resource)	Dynamically registers a pre-instantiated child REST resource at an explicit path.
RestChildren	getChildResources()	Returns the RestChildren registry backing this group resource.
RestContext	removeChild(Class<?> resourceClass)	Removes the first child whose resource class matches the given type.
RestContext	removeChild(String path)	Removes the child registered at the given composed path.

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

builder, doLog, getContext, getPaths, getRequest, getResponse, getRestBuilder, log, log, setContext

Methods inherited from class java.lang.Object

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

Constructor Details

BasicRestResourceGroup

public BasicRestResourceGroup()

Method Details

getChildResources

public RestChildren getChildResources()

Returns the RestChildren registry backing this group resource.

Use this for full access to the dynamic add/remove API, including the replace overloads and the unmodifiable asMap() snapshot.

Returns:

The RestChildren registry for this resource's RestContext.

addChild

public RestContext addChild(Class<?> resourceClass)
                     throws jakarta.servlet.ServletException

Dynamically registers a child REST resource by class.

Convenience pass-through to RestChildren.addChild(Class) on getChildResources().

Parameters:

resourceClass - The @Rest-annotated resource class.

Returns:

The newly-built child RestContext.

Throws:

jakarta.servlet.ServletException - If construction or lifecycle initialization of the child fails.

addChild

public RestContext addChild(Object resource)
                     throws jakarta.servlet.ServletException

Dynamically registers a pre-instantiated child REST resource.

Convenience pass-through to RestChildren.addChild(Object) on getChildResources().

Parameters:

resource - The @Rest-annotated resource instance.

Returns:

The newly-built child RestContext.

Throws:

jakarta.servlet.ServletException - If construction or lifecycle initialization of the child fails.

addChild

public RestContext addChild(String path,
 Object resource)
                     throws jakarta.servlet.ServletException

Dynamically registers a pre-instantiated child REST resource at an explicit path.

Convenience pass-through to RestChildren.addChild(String, Object) on getChildResources().

Parameters:

path - The path segment under this group at which to mount the child.

resource - The @Rest-annotated resource instance.

Returns:

The newly-built child RestContext.

Throws:

jakarta.servlet.ServletException - If construction or lifecycle initialization of the child fails.

removeChild

public RestContext removeChild(String path)

Removes the child registered at the given composed path.

Convenience pass-through to RestChildren.removeChild(String) on getChildResources().

Parameters:

path - The composed path key (as returned by RestContext.getPath()).

Returns:

The removed and destroyed RestContext, or null if no child was registered there.

removeChild

public RestContext removeChild(Class<?> resourceClass)

Removes the first child whose resource class matches the given type.

Convenience pass-through to RestChildren.removeChild(Class) on getChildResources().

Parameters:

resourceClass - The resource class to match.

Returns:

The removed and destroyed RestContext, or null if no matching child was found.