Package org.apache.juneau.rest.servlet

Class BasicRestObject

java.lang.Object

org.apache.juneau.rest.servlet.RestObject

org.apache.juneau.rest.servlet.BasicRestObject

All Implemented Interfaces:

BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig, BasicRestOperations

Direct Known Subclasses:

BasicRestObjectGroup, HelloWorldResource, HtmlBeansResource, RequestEchoResource, UtilityBeansResource

public abstract class BasicRestObject
extends RestObject
implements BasicRestOperations, BasicUniversalConfig

Identical to BasicRestServlet but doesn't extend from HttpServlet.

Meant as a base class for child REST resources in servlet containers and 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.

See Also:

• @Rest-Annotated Classes

Constructor Summary

Constructors

Constructor	Description
BasicRestObject()

Method Summary

Modifier and Type	Method	Description
void	error()	[* /error] - Error occurred.
HttpResource	getFavIcon()	[GET favicon.ico] - Retrieve favorites icon image.
HttpResource	getHtdoc(String path, Locale locale)	[GET /htdocs/*] - Retrieve static file.
RestContextStats	getStats(RestRequest req)	[GET /stats] - Timing statistics.
Swagger	getSwagger(RestRequest req)	[GET /api] - Show resource options.

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

BasicRestObject

public BasicRestObject()

Method Details

getSwagger

public Swagger getSwagger(RestRequest req)

Description copied from interface: BasicRestOperations

[GET /api] - Show resource options.

Specified by:

getSwagger in interface BasicRestOperations

Parameters:

req - The HTTP request.

Returns:

A bean containing the contents for the OPTIONS page.

getHtdoc

public HttpResource getHtdoc(@Path("/*")
 String path,
 Locale locale)
                      throws NotFound

Description copied from interface: BasicRestOperations

[GET /htdocs/*] - Retrieve static file.

Specified by:

getHtdoc in interface BasicRestOperations

Parameters:

path - The path to retrieve.

locale - The locale of the HTTP request.

Returns:

An HTTP resource representing the static file.

Throws:

NotFound

getFavIcon

public HttpResource getFavIcon()

Description copied from interface: BasicRestOperations

[GET favicon.ico] - Retrieve favorites icon image.

Specified by:

getFavIcon in interface BasicRestOperations

Returns:

A bean containing the contents for the OPTIONS page.

error

public void error()

Description copied from interface: BasicRestOperations

[* /error] - Error occurred.

Specified by:

error in interface BasicRestOperations

getStats

public RestContextStats getStats(RestRequest req)

Description copied from interface: BasicRestOperations

[GET /stats] - Timing statistics.

Timing statistics for method invocations on this resource.

Specified by:

getStats in interface BasicRestOperations

Parameters:

req - The HTTP request.

Returns:

A collection of timing statistics for each annotated method on this resource.