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; 014 015import static org.apache.juneau.http.HttpMethodName.*; 016 017import org.apache.juneau.rest.annotation.*; 018import org.apache.juneau.rest.helper.*; 019 020/** 021 * Specialized subclass of {@link BasicRestServlet} for showing "group" pages. 022 * 023 * <p> 024 * Group pages consist of simple lists of child resource URLs and their labels. 025 * They're meant to be used as jumping-off points for child resources. 026 * 027 * <p> 028 * Child resources are specified using the {@link RestResource#children() @RestResource(children)} annotation. 029 * 030 * <h5 class='section'>See Also:</h5> 031 * <ul> 032 * <li class='link'>{@doc juneau-rest-server.Instantiation.RouterPages} 033 * </ul> 034 */ 035@RestResource 036public abstract class BasicRestServletGroup extends BasicRestServlet { 037 private static final long serialVersionUID = 1L; 038 039 /** 040 * [GET /] - Get child resources. 041 * 042 * @param req The HTTP request. 043 * @return The bean containing links to the child resources. 044 * @throws Exception 045 */ 046 @RestMethod(name=GET, path="/", summary="Navigation page") 047 public ChildResourceDescriptions getChildren(RestRequest req) throws Exception { 048 return new ChildResourceDescriptions(req); 049 } 050} 051