/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.juneau.http.response;

import static org.apache.juneau.http.response.Found.*;

import java.net.*;
import java.util.*;

import org.apache.http.*;
import org.apache.http.Header;
import org.apache.juneau.annotation.*;
import org.apache.juneau.http.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.http.header.*;
import org.apache.juneau.internal.*;

/**
 * Represents an <c>HTTP 302 Found</c> response.
 *
 * <p>
 * Tells the client to look at (browse to) another url. 302 has been superseded by 303 and 307.
 * This is an example of industry practice contradicting the standard.
 * 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.
 * Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours.
 * However, some Web applications and frameworks use the 302 status code as if it were the 303.
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestCommonBasics">juneau-rest-common Basics</a>
 * </ul>
 */
@Response
@StatusCode(STATUS_CODE)
@Schema(description=REASON_PHRASE)
public class Found extends BasicHttpResponse {

   /** HTTP status code */
   public static final int STATUS_CODE = 302;

   /** Default message */
   public static final String REASON_PHRASE = "Found";

   /** Default status line */
   private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE);

   /** Default unmodifiable instance */
   public static final Found INSTANCE = new Found().setUnmodifiable();

   /**
    * Constructor.
    */
   public Found() {
      super(STATUS_LINE);
   }

   /**
    * Copy constructor.
    *
    * @param copyFrom The bean to copy from.
    */
   public Found(Found copyFrom) {
      super(copyFrom);
   }

   /**
    * Constructor.
    *
    * <p>
    * This is the constructor used when parsing an HTTP response.
    *
    * @param response The HTTP response to copy from.  Must not be <jk>null</jk>.
    * @throws AssertionError If HTTP response status code does not match what was expected.
    */
   public Found(HttpResponse response) {
      super(response);
      assertStatusCode(response);
   }

   /**
    * Creates a builder for this class initialized with the contents of this bean.
    *
    * @return A new builder bean.
    */
   public Found copy() {
      return new Found(this);
   }
   @Override /* Overridden from BasicHttpResponse */
   public Found setContent(String value) {
      super.setContent(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setContent(HttpEntity value) {
      super.setContent(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setHeader2(Header value) {
      super.setHeader2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setHeader2(String name, String value) {
      super.setHeader2(name, value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setHeaders(List<Header> values) {
      super.setHeaders(values);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setHeaders(HeaderList value) {
      super.setHeaders(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setHeaders2(Header...values) {
      super.setHeaders2(values);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setLocale2(Locale value) {
      super.setLocale2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setLocation(String value) {
      super.setLocation(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setLocation(URI value) {
      super.setLocation(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setProtocolVersion(ProtocolVersion value) {
      super.setProtocolVersion(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setReasonPhrase2(String value) {
      super.setReasonPhrase2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setReasonPhraseCatalog(ReasonPhraseCatalog value) {
      super.setReasonPhraseCatalog(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setStatusCode2(int value) {
      super.setStatusCode2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setStatusLine(BasicStatusLine value) {
      super.setStatusLine(value);
      return this;
   }

   @Override /* Overridden from BasicHttpResponse */
   public Found setUnmodifiable() {
      super.setUnmodifiable();
      return this;
   }
}