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.http.response;
018
019import static org.apache.juneau.http.response.Found.*;
020
021import java.net.*;
022import java.util.*;
023
024import org.apache.http.*;
025import org.apache.http.Header;
026import org.apache.juneau.annotation.*;
027import org.apache.juneau.http.*;
028import org.apache.juneau.http.annotation.*;
029import org.apache.juneau.http.header.*;
030
031/**
032 * Represents an <c>HTTP 302 Found</c> response.
033 *
034 * <p>
035 * Tells the client to look at (browse to) another url. 302 has been superseded by 303 and 307.
036 * This is an example of industry practice contradicting the standard.
037 * The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302 with the functionality of a 303 See Other.
038 * Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours.
039 * However, some Web applications and frameworks use the 302 status code as if it were the 303.
040 *
041 * <h5 class='section'>See Also:</h5><ul>
042 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestCommonBasics">juneau-rest-common Basics</a>
043 * </ul>
044 */
045@Response
046@StatusCode(STATUS_CODE)
047@Schema(description = REASON_PHRASE)
048public class Found extends BasicHttpResponse {
049
050   /** HTTP status code */
051   public static final int STATUS_CODE = 302;
052
053   /** Default message */
054   public static final String REASON_PHRASE = "Found";
055
056   /** Default status line */
057   private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE);
058
059   /** Default unmodifiable instance */
060   public static final Found INSTANCE = new Found().setUnmodifiable();
061
062   /**
063    * Constructor.
064    */
065   public Found() {
066      super(STATUS_LINE);
067   }
068
069   /**
070    * Copy constructor.
071    *
072    * @param copyFrom The bean to copy from.
073    */
074   public Found(Found copyFrom) {
075      super(copyFrom);
076   }
077
078   /**
079    * Constructor.
080    *
081    * <p>
082    * This is the constructor used when parsing an HTTP response.
083    *
084    * @param response The HTTP response to copy from.  Must not be <jk>null</jk>.
085    * @throws AssertionError If HTTP response status code does not match what was expected.
086    */
087   public Found(HttpResponse response) {
088      super(response);
089      assertStatusCode(response);
090   }
091
092   /**
093    * Creates a builder for this class initialized with the contents of this bean.
094    *
095    * @return A new builder bean.
096    */
097   public Found copy() {
098      return new Found(this);
099   }
100
101   @Override /* Overridden from BasicHttpResponse */
102   public Found setContent(HttpEntity value) {
103      super.setContent(value);
104      return this;
105   }
106
107   @Override /* Overridden from BasicHttpResponse */
108   public Found setContent(String value) {
109      super.setContent(value);
110      return this;
111   }
112
113   @Override /* Overridden from BasicHttpResponse */
114   public Found setHeader2(Header value) {
115      super.setHeader2(value);
116      return this;
117   }
118
119   @Override /* Overridden from BasicHttpResponse */
120   public Found setHeader2(String name, String value) {
121      super.setHeader2(name, value);
122      return this;
123   }
124
125   @Override /* Overridden from BasicHttpResponse */
126   public Found setHeaders(HeaderList value) {
127      super.setHeaders(value);
128      return this;
129   }
130
131   @Override /* Overridden from BasicHttpResponse */
132   public Found setHeaders(List<Header> values) {
133      super.setHeaders(values);
134      return this;
135   }
136
137   @Override /* Overridden from BasicHttpResponse */
138   public Found setHeaders2(Header...values) {
139      super.setHeaders2(values);
140      return this;
141   }
142
143   @Override /* Overridden from BasicHttpResponse */
144   public Found setLocale2(Locale value) {
145      super.setLocale2(value);
146      return this;
147   }
148
149   @Override /* Overridden from BasicHttpResponse */
150   public Found setLocation(String value) {
151      super.setLocation(value);
152      return this;
153   }
154
155   @Override /* Overridden from BasicHttpResponse */
156   public Found setLocation(URI value) {
157      super.setLocation(value);
158      return this;
159   }
160
161   @Override /* Overridden from BasicHttpResponse */
162   public Found setProtocolVersion(ProtocolVersion value) {
163      super.setProtocolVersion(value);
164      return this;
165   }
166
167   @Override /* Overridden from BasicHttpResponse */
168   public Found setReasonPhrase2(String value) {
169      super.setReasonPhrase2(value);
170      return this;
171   }
172
173   @Override /* Overridden from BasicHttpResponse */
174   public Found setReasonPhraseCatalog(ReasonPhraseCatalog value) {
175      super.setReasonPhraseCatalog(value);
176      return this;
177   }
178
179   @Override /* Overridden from BasicHttpResponse */
180   public Found setStatusCode2(int value) {
181      super.setStatusCode2(value);
182      return this;
183   }
184
185   @Override /* Overridden from BasicHttpResponse */
186   public Found setStatusLine(BasicStatusLine value) {
187      super.setStatusLine(value);
188      return this;
189   }
190
191   @Override /* Overridden from BasicHttpResponse */
192   public Found setUnmodifiable() {
193      super.setUnmodifiable();
194      return this;
195   }
196}