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.server.springboot;
018
019import org.apache.juneau.rest.server.*;
020import org.apache.juneau.rest.server.config.*;
021import org.apache.juneau.rest.server.ops.*;
022
023/**
024 * Specialized subclass of {@link BasicSpringRestServlet} for showing "group" pages.
025 *
026 * <p>
027 * Meant as a base class for top-level REST resources in Spring Boot environments.
028 *
029 * <p>
030 * Provides support for JSON, XML, HTML, URL-Encoding, UON, XML, OpenAPI, and MessagePack.  See {@link BasicUniversalConfig}
031 * for details.
032 *
033 * <p>
034 * Adds the group-navigation endpoint ({@code GET /}) by composing {@link NavigationMixin} via
035 * {@link Rest#mixins() @Rest(mixins=...)} on top of the residual op-mixins inherited from
036 * {@link BasicSpringRestServlet}. The navigation op lives on the {@code NavigationMixin} sub-context (backed
037 * by {@link org.apache.juneau.rest.server.servlet.RestMixin#getHostContext()}) but renders with the host's
038 * {@link org.apache.juneau.marshall.html.HtmlDocConfig @HtmlDocConfig} page decoration &mdash; mixin
039 * sub-contexts inherit the host's class-level {@code @HtmlDocConfig} (and other class-level config), so the
040 * navigation page matches the host's other endpoints.
041 *
042 * <p>
043 * Children are attached to this resource using the {@link Rest#children() @Rest(children)} annotation.
044 *
045 * <h5 class='section'>See Also:</h5><ul>
046 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestServerSpringboot">juneau-rest-server-springboot</a>
047 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestAnnotatedClasses">@Rest-Annotated Class</a>
048 * </ul>
049 *
050 * @serial exclude
051 */
052@Rest(mixins=NavigationMixin.class)
053@SuppressWarnings({
054   "java:S110" // Inheritance depth acceptable for BasicSpringRestServletGroup hierarchy
055})
056public abstract class BasicSpringRestServletGroup extends BasicSpringRestServlet {
057   private static final long serialVersionUID = 1L;
058}