001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.examples.rest;
018
019import org.apache.juneau.html.annotation.*;
020import org.apache.juneau.rest.annotation.*;
021import org.apache.juneau.rest.servlet.*;
022
023/**
024 * Sample REST resource that prints out a simple "Hello world!" message.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027
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 extends BasicRestObject {
044
045   /**
046    * [HTTP GET /helloworld]
047    * Returns a simple string message.
048    *
049    * @return A simple Hello-World message.
050    */
051   @RestGet(path="/*", summary="Responds with \"Hello world!\"")
052   public String sayHello() {
053      return "Hello world!";
054   }
055}