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.rest.servlet;
014
015import org.apache.juneau.rest.*;
016import org.apache.juneau.rest.annotation.*;
017import org.apache.juneau.rest.beans.*;
018import org.apache.juneau.rest.config.*;
019
020/**
021 * Specialized subclass of {@link BasicRestServlet} for showing "group" pages.
022 *
023 * <p>
024 * Meant as a base class for top-level REST resources in servlet containers.
025 *
026 * <p>
027 * Provides support for JSON, XML, HTML, URL-Encoding, UON, XML, OpenAPI, and MessagePack.  See {@link BasicUniversalConfig}
028 * for details.
029 *
030 * <p>
031 * Implements the basic REST endpoints defined in {@link BasicRestOperations} and {@link BasicGroupOperations}.
032 *
033 * <p>
034 * Children are attached to this resource using the {@link Rest#children() @Rest(children)} annotation.
035 *
036 * <h5 class='section'>See Also:</h5><ul>
037 *    <li class='link'><a class="doclink" href="../../../../../index.html#jrs.AnnotatedClasses">@Rest-Annotated Classes</a>
038 * </ul>
039 *
040 * @serial exclude
041 */
042@Rest
043public abstract class BasicRestServletGroup extends BasicRestServlet implements BasicGroupOperations {
044   private static final long serialVersionUID = 1L;
045
046
047   @Override /* BasicGroupOperations */
048   public ChildResourceDescriptions getChildren(RestRequest req) {
049      return ChildResourceDescriptions.of(req);
050   }
051}
052