Package org.apache.juneau.rest

Class RestChildren

java.lang.Object

org.apache.juneau.rest.RestChildren

Direct Known Subclasses:

RestChildren.Void

public class RestChildren
extends Object

Implements the child resources of a Rest-annotated class.

See Also:

• @Rest-Annotated Class Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestChildren.Builder	Builder class.
final class	RestChildren.Void	Represents a null value for the Rest.restChildrenClass() annotation.

Constructor Summary

Constructors

Constructor	Description
RestChildren(RestChildren.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
Map<String,RestContext>	asMap()	Returns the children in this object as a map.
static RestChildren.Builder	create(BeanStore beanStore)	Static creator.
void	destroy()	Called during servlet destruction on all children to invoke all RestDestroy and Servlet.destroy() methods.
Optional<RestChildMatch>	findMatch(RestSession.Builder builder)	Looks through the registered children of this object and returns the best match.
void	postInit()	Called during servlet initialization on all children to invoke all RestPostInit child-last methods.
void	postInitChildFirst()	Called during servlet initialization on all children to invoke all RestPostInit child-first methods.

Methods inherited from class java.lang.Object

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

Constructor Details

RestChildren

public RestChildren(RestChildren.Builder builder)

Constructor.

Parameters:

builder - The builder containing the settings for this object.

Method Details

create

public static RestChildren.Builder create(BeanStore beanStore)

Static creator.

Parameters:

beanStore - The bean store to use for creating beans.

Returns:

A new builder for this object.

asMap

public Map<String,RestContext> asMap()

Returns the children in this object as a map.

The keys are the paths of the child contexts.

Returns:

The children as an unmodifiable map.

destroy

public void destroy()

Called during servlet destruction on all children to invoke all RestDestroy and Servlet.destroy() methods.

findMatch

public Optional<RestChildMatch> findMatch(RestSession.Builder builder)

Looks through the registered children of this object and returns the best match.

Parameters:

builder - The HTTP call builder.

Returns:

The child that best matches the call, or an empty Optional if a match could not be made.

postInit

public void postInit()
              throws jakarta.servlet.ServletException

Called during servlet initialization on all children to invoke all RestPostInit child-last methods.

Throws:

jakarta.servlet.ServletException - Error occurred.

postInitChildFirst

public void postInitChildFirst()
                        throws jakarta.servlet.ServletException

Called during servlet initialization on all children to invoke all RestPostInit child-first methods.

Throws:

jakarta.servlet.ServletException - Error occurred.