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.helper;
014
015import java.net.*;
016
017import org.apache.juneau.http.annotation.*;
018import org.apache.juneau.http.response.*;
019
020/**
021 * Convenience subclass of {@link SeeOther} for redirecting a response to the servlet root.
022 */
023@Response(description="Redirect to servlet root")
024public class SeeOtherRoot extends SeeOther {
025
026   /**
027    * Reusable instance.
028    */
029   public static final SeeOtherRoot INSTANCE = new SeeOtherRoot();
030
031   /**
032    * Constructor.
033    */
034   public SeeOtherRoot() {
035      super(URI.create("servlet:/"));
036   }
037
038   /**
039    * Constructor with no redirect.
040    * <p>
041    * Used for end-to-end interfaces.
042    *
043    * @param message Message to send as the response.
044    */
045   public SeeOtherRoot(String message) {
046      super(message);
047   }
048}