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.microservice.examples;
018
019import org.apache.juneau.rest.server.*;
020import org.apache.juneau.rest.server.servlet.*;
021
022/**
023 * Sample root REST resource.
024 *
025 * <p>
026 * It mounts {@link ConfigResource} with no CSRF boundary in front of it.  {@code ConfigResource} has no HTML form, and
027 * its writes are {@code PUT}s, which a browser cannot send cross-site without a CORS preflight.  An application that
028 * mounts the admin resources where a browser can reach them should still register {@link AdminBoundary}.
029 *
030 * <h5 class='section'>See Also:</h5><ul>
031 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauMicroservice">juneau-microservice</a>
032 * </ul>
033 *
034 * @serial exclude
035 */
036@Rest(
037   path="/",
038   title="Sample Root Resource",
039   description="This is a sample router page",
040   children={ConfigResource.class}
041)
042@SuppressWarnings({
043   "java:S110" // Inheritance depth acceptable for microservice hierarchy
044})
045public class SampleRootResource extends BasicRestServletGroup {
046   private static final long serialVersionUID = 1L;
047}