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.beans;
014
015import org.apache.juneau.annotation.*;
016import org.apache.juneau.http.annotation.*;
017import org.apache.juneau.http.response.*;
018
019/**
020 * Convenience subclass of {@link SeeOther} for redirecting a response to the servlet root.
021 *
022 * <h5 class='section'>See Also:</h5><ul>
023 *    <li class='link'><a class="doclink" href="../../../../../index.html#jrs.UtilityBeans">Utility Beans</a>
024 * </ul>
025 */
026@Response @Schema(description="Redirect to servlet root")
027public class SeeOtherRoot extends SeeOther {
028
029   /**
030    * Reusable instance.
031    */
032   public static final SeeOtherRoot INSTANCE = new SeeOtherRoot();
033
034   /**
035    * Constructor.
036    */
037   public SeeOtherRoot() {
038      setLocation("servlet:/");
039   }
040
041   /**
042    * Constructor with no redirect.
043    * <p>
044    * Used for end-to-end interfaces.
045    *
046    * @param content Message to send as the response.
047    */
048   public SeeOtherRoot(String content) {
049      setLocation("servlet:/");
050      setContent(content);
051   }
052}