org.apache.juneau.rest

Class BasicRestServletGroup

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.rest.BasicRestServletGroup

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, BasicRestConfig

Direct Known Subclasses:

BasicRestServletJenaGroup, RootResources, SampleRootResource

@RestResource
public abstract class BasicRestServletGroup
extends BasicRestServlet

Specialized subclass of BasicRestServlet for showing "group" pages.

Group pages consist of simple lists of child resource URLs and their labels. They're meant to be used as jumping-off points for child resources.

Child resources are specified using the @RestResource.children() annotation.

See Also:

• Overview > juneau-rest-server > Router Pages

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicRestServletGroup()

Method Summary

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

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

getOptions

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

destroy, getContext, getProperties, getServletConfig, init, log, log, log, log, logObjects, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicRestServletGroup

public BasicRestServletGroup()

Method Detail

getChildren

@RestMethod(name="GET",
            path="/",
            description="Child resources")
public ChildResourceDescriptions getChildren(RestRequest req)
                                                                                                                               throws Exception

[GET /] - Get child resources.

Parameters:

req - The HTTP request.

Returns:

The bean containing links to the child resources.

Throws:

Exception