Package org.apache.juneau.rest.servlet

Interface BasicRestOperations

All Known Implementing Classes:
AtomFeedResource, BasicRestObject, BasicRestObjectGroup, BasicRestServlet, BasicRestServletGroup, BasicSpringRestServlet, BasicSpringRestServletGroup, ConfigResource, DebugResource, DirectoryResource, DtoExamples, HelloWorldResource, HelloWorldResource, HelloWorldResource, HtmlBeansResource, JsonSchemaResource, LogsResource, PhotosResource, RequestEchoResource, RootResources, RootResources, RootResources, RrpcServlet, SampleRootResource, ShutdownResource, UtilityBeansResource
public interface BasicRestOperations
Basic REST operation methods.

Defines 5 special use REST operation endpoints:

@RestGet(path="/api/*") public Swagger getSwagger(RestRequest req); @RestGet(path="/htdocs/*") public HttpResource getHtdoc(@Path String path, Locale locale); @RestGet(path="favicon.ico") public HttpResource getFavIcon(); @RestGet(path="/stats") public RestContextStats getStats(RestRequest req); @RestOp(method=ANY, path="/error") public void error();

Implementations provided by the following classes:

See Also:

  • Method Details

    • getSwagger

      Swagger getSwagger(RestRequest req)
      [GET /api] - Show resource options.
      Parameters:
      req - The HTTP request.
      Returns:
      A bean containing the contents for the OPTIONS page.

    • getHtdoc

      HttpResource getHtdoc(@Path String path, Locale locale)
      [GET /htdocs/*] - Retrieve static file.
      Parameters:
      path - The path to retrieve.
      locale - The locale of the HTTP request.
      Returns:
      An HTTP resource representing the static file.

    • getFavIcon

      HttpResource getFavIcon()
      [GET favicon.ico] - Retrieve favorites icon image.
      Returns:
      A bean containing the contents for the OPTIONS page.

    • error

      void error()
      [* /error] - Error occurred.

    • getStats

      RestContextStats getStats(RestRequest req)
      [GET /stats] - Timing statistics.

      Timing statistics for method invocations on this resource.

      Parameters:
      req - The HTTP request.
      Returns:
      A collection of timing statistics for each annotated method on this resource.