001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.examples.rest;
014
015import static org.apache.juneau.http.HttpMethodName.*;
016
017import org.apache.juneau.dto.swagger.*;
018import org.apache.juneau.html.annotation.*;
019import org.apache.juneau.http.exception.*;
020import org.apache.juneau.rest.*;
021import org.apache.juneau.rest.annotation.*;
022
023/**
024 * Sample REST resource that prints out a simple "Hello world!" message.
025 *
026 * <ul class='seealso'>
027 *    <li class='extlink'>{@source}
028 * </ul>
029 */
030@Rest(
031   title="Hello World",
032   description="An example of the simplest-possible resource",
033   path="/helloWorld"
034)
035@HtmlDocConfig(
036   aside={
037      "<div style='max-width:400px' class='text'>",
038      "  <p>This page shows a resource that simply response with a 'Hello world!' message</p>",
039      "  <p>The POJO serialized is a simple String.</p>",
040      "</div>"
041   }
042)
043public class HelloWorldResource implements BasicRestConfig {
044
045   /**
046    * GET request handler.
047    *
048    * @return A simple Hello-World message.
049    */
050   @RestMethod(name=GET, path="/*", summary="Responds with \"Hello world!\"")
051   public String sayHello() {
052      return "Hello world!";
053   }
054
055   /**
056    * Make a request to /helloWorld/badRequest to trigger a 400 Bad Request.
057    *
058    * @throws BadRequest A bad request.
059    */
060   @RestMethod
061   public void getBadRequest() throws BadRequest {
062      throw new BadRequest("example");
063   }
064
065   @Override /* BasicRestConfig */
066   public Swagger getOptions(RestRequest req) {
067      return req.getSwagger();
068   }
069
070   @Override /* BasicRestConfig */
071   public void error() {}
072
073   @Override /* BasicRestConfig */
074   public RestContextStats getStats(RestRequest req) {
075      return req.getContext().getStats();
076   }
077}