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