org.apache.juneau.examples.rest

Class HelloWorldResource

java.lang.Object

org.apache.juneau.examples.rest.HelloWorldResource

All Implemented Interfaces:

BasicRestConfig

@Rest(title="Hello World",
      description="An example of the simplest-possible resource",
      path="/helloWorld")
 @HtmlDocConfig(aside={"<div style=\'max-width:400px\' class=\'text\'>","\t<p>This page shows a resource that simply response with a \'Hello world!\' message</p>","\t<p>The POJO serialized is a simple String.</p>","</div>"})
public class HelloWorldResource
extends Object
implements BasicRestConfig

Sample REST resource that prints out a simple "Hello world!" message.

• Source

Constructor Summary

Constructors

Constructor and Description
HelloWorldResource()

Method Summary

Modifier and Type	Method and Description
void	error() [* /error] - Error occurred.
void	getBadRequest() Make a request to /helloWorld/badRequest to trigger a 400 Bad Request.
Swagger	getOptions(RestRequest req) [OPTIONS /*] - Show resource options.
RestContextStats	getStats(RestRequest req) [GET /stats] - Timing statistics.
String	sayHello() GET request handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelloWorldResource

public HelloWorldResource()

Method Detail

sayHello

@RestMethod(name="GET",
            path="/*",
            summary="Responds with \"Hello world!\"")
public String sayHello()

GET request handler.

Returns:

A simple Hello-World message.

getBadRequest

@RestMethod
public void getBadRequest()
                               throws BadRequest

Make a request to /helloWorld/badRequest to trigger a 400 Bad Request.

Throws:

BadRequest - A bad request.

getOptions

public Swagger getOptions(RestRequest req)

Description copied from interface: BasicRestConfig

[OPTIONS /*] - Show resource options.

Specified by:

getOptions in interface BasicRestConfig

Parameters:

req - The HTTP request.

Returns:

A bean containing the contents for the OPTIONS page.

error

public void error()

Description copied from interface: BasicRestConfig

[* /error] - Error occurred.

Servlet chains will often automatically redirect to "/error" when any sort of error condition occurs (such as failed authentication) and will set appropriate response parameters (such as an WWW-Authenticate response header).

These responses should be left as-is without any additional processing.

Specified by:

error in interface BasicRestConfig

getStats

public RestContextStats getStats(RestRequest req)

Description copied from interface: BasicRestConfig

[GET /stats] - Timing statistics.

Timing statistics for method invocations on this resource.

Specified by:

getStats in interface BasicRestConfig

Parameters:

req - The HTTP request.

Returns:

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