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