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.beans;
018
019import org.apache.juneau.commons.*;
020import org.apache.juneau.http.*;
021import org.apache.juneau.http.response.*;
022
023/**
024 * Convenience subclass of {@link SeeOther} for redirecting a response to the servlet root.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/UtilityBeans">Utility Beans</a>
028 * </ul>
029 */
030@Response
031@Schema(description = "Redirect to servlet root")
032public class SeeOtherRoot extends SeeOther {
033
034   /**
035    * Reusable instance.
036    */
037   public static final SeeOtherRoot INSTANCE = new SeeOtherRoot();
038
039   /**
040    * Constructor.
041    */
042   public SeeOtherRoot() {
043      setLocation("servlet:/");
044   }
045
046   /**
047    * Copy constructor.
048    *
049    * @param copyFrom The object to copy.
050    *    <br>Must not be <jk>null</jk>.
051    */
052   public SeeOtherRoot(SeeOtherRoot copyFrom) {
053      super(copyFrom);
054   }
055
056   /**
057    * Constructor with no redirect.
058    * <p>
059    * Used for end-to-end interfaces.
060    *
061    * @param content Message to send as the response.
062    *    <br>Can be <jk>null</jk> for no response body.
063    */
064   public SeeOtherRoot(String content) {
065      super(content);
066      setLocation("servlet:/");
067   }
068}