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.HttpMethod.*;
016
017import org.apache.juneau.html.annotation.*;
018import org.apache.juneau.rest.annotation.*;
019import org.apache.juneau.rest.config.*;
020
021/**
022 * Sample REST resource that prints out a simple "Hello world!" message.
023 *
024 * <ul class='seealso'>
025 *    <li class='extlink'>{@source}
026 * </ul>
027 */
028@Rest(
029   title="Hello World",
030   description="An example of the simplest-possible resource",
031   path="/helloWorld"
032)
033@HtmlDocConfig(
034   aside={
035      "<div style='max-width:400px' class='text'>",
036      "  <p>This page shows a resource that simply response with a 'Hello world!' message</p>",
037      "  <p>The POJO serialized is a simple String.</p>",
038      "</div>"
039   }
040)
041public class HelloWorldResource implements BasicUniversalRest {
042
043   /**
044    * GET request handler.
045    *
046    * @return A simple Hello-World message.
047    */
048   @RestMethod(name=GET, path="/*", summary="Responds with \"Hello world!\"")
049   public String sayHello() {
050      return "Hello world!";
051   }
052}