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.Accepted.*;
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 202 Accepted</c> response.
033 *
034 * <p>
035 * The request has been accepted for processing, but the processing has not been completed.
036 * The request might or might not be eventually acted upon, and may be disallowed when processing occurs.
037 *
038 * <h5 class='section'>See Also:</h5><ul>
039 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestCommonBasics">juneau-rest-common Basics</a>
040 * </ul>
041 */
042@Response
043@StatusCode(STATUS_CODE)
044@Schema(description = REASON_PHRASE)
045public class Accepted extends BasicHttpResponse {
046
047   /** HTTP status code */
048   public static final int STATUS_CODE = 202;
049
050   /** Reason phrase */
051   public static final String REASON_PHRASE = "Accepted";
052
053   /** Default status line */
054   private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE);
055
056   /** Default unmodifiable instance */
057   public static final Accepted INSTANCE = new Accepted().setUnmodifiable();
058
059   /**
060    * Constructor.
061    */
062   public Accepted() {
063      super(STATUS_LINE);
064   }
065
066   /**
067    * Copy constructor.
068    *
069    * @param copyFrom The bean to copy from.
070    */
071   public Accepted(Accepted copyFrom) {
072      super(copyFrom);
073   }
074
075   /**
076    * Constructor.
077    *
078    * <p>
079    * This is the constructor used when parsing an HTTP response.
080    *
081    * @param response The HTTP response to copy from.  Must not be <jk>null</jk>.
082    * @throws AssertionError If HTTP response status code does not match what was expected.
083    */
084   public Accepted(HttpResponse response) {
085      super(response);
086      assertStatusCode(response);
087   }
088
089   /**
090    * Creates a builder for this class initialized with the contents of this bean.
091    *
092    * @return A new builder bean.
093    */
094   public Accepted copy() {
095      return new Accepted(this);
096   }
097
098   @Override /* Overridden from BasicHttpResponse */
099   public Accepted setContent(HttpEntity value) {
100      super.setContent(value);
101      return this;
102   }
103
104   @Override /* Overridden from BasicHttpResponse */
105   public Accepted setContent(String value) {
106      super.setContent(value);
107      return this;
108   }
109
110   @Override /* Overridden from BasicHttpResponse */
111   public Accepted setHeader2(Header value) {
112      super.setHeader2(value);
113      return this;
114   }
115
116   @Override /* Overridden from BasicHttpResponse */
117   public Accepted setHeader2(String name, String value) {
118      super.setHeader2(name, value);
119      return this;
120   }
121
122   @Override /* Overridden from BasicHttpResponse */
123   public Accepted setHeaders(HeaderList value) {
124      super.setHeaders(value);
125      return this;
126   }
127
128   @Override /* Overridden from BasicHttpResponse */
129   public Accepted setHeaders(List<Header> values) {
130      super.setHeaders(values);
131      return this;
132   }
133
134   @Override /* Overridden from BasicHttpResponse */
135   public Accepted setHeaders2(Header...values) {
136      super.setHeaders2(values);
137      return this;
138   }
139
140   @Override /* Overridden from BasicHttpResponse */
141   public Accepted setLocale2(Locale value) {
142      super.setLocale2(value);
143      return this;
144   }
145
146   @Override /* Overridden from BasicHttpResponse */
147   public Accepted setLocation(String value) {
148      super.setLocation(value);
149      return this;
150   }
151
152   @Override /* Overridden from BasicHttpResponse */
153   public Accepted setLocation(URI value) {
154      super.setLocation(value);
155      return this;
156   }
157
158   @Override /* Overridden from BasicHttpResponse */
159   public Accepted setProtocolVersion(ProtocolVersion value) {
160      super.setProtocolVersion(value);
161      return this;
162   }
163
164   @Override /* Overridden from BasicHttpResponse */
165   public Accepted setReasonPhrase2(String value) {
166      super.setReasonPhrase2(value);
167      return this;
168   }
169
170   @Override /* Overridden from BasicHttpResponse */
171   public Accepted setReasonPhraseCatalog(ReasonPhraseCatalog value) {
172      super.setReasonPhraseCatalog(value);
173      return this;
174   }
175
176   @Override /* Overridden from BasicHttpResponse */
177   public Accepted setStatusCode2(int value) {
178      super.setStatusCode2(value);
179      return this;
180   }
181
182   @Override /* Overridden from BasicHttpResponse */
183   public Accepted setStatusLine(BasicStatusLine value) {
184      super.setStatusLine(value);
185      return this;
186   }
187
188   @Override /* Overridden from BasicHttpResponse */
189   public Accepted setUnmodifiable() {
190      super.setUnmodifiable();
191      return this;
192   }
193}