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.response;
014
015import static org.apache.juneau.rest.response.Continue.*;
016
017import org.apache.juneau.http.annotation.*;
018
019/**
020 * Represents an <code>HTTP 100 Continue</code> response.
021 *
022 * <p>
023 * The server has received the request headers and the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request).
024 * Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient.
025 * To have a server check the request's headers, a client must send Expect: 100-continue as a header in its initial request and receive a 100 Continue status code in response before sending the body.
026 * If the client receives an error code such as 403 (Forbidden) or 405 (Method Not Allowed) then it shouldn't send the request's body.
027 * The response 417 Expectation Failed indicates that the request should be repeated without the Expect header as it indicates that the server doesn't support expectations (this is the case, for example, of HTTP/1.0 servers).
028 */
029@Response(code=CODE, description=MESSAGE)
030public class Continue extends HttpResponse {
031
032   /** HTTP status code */
033   public static final int CODE = 100;
034
035   /** Default message */
036   public static final String MESSAGE = "Continue";
037
038   /** Reusable instance.*/
039   public static final Continue INSTANCE = new Continue();
040
041   /**
042    * Constructor using HTTP-standard message.
043    */
044   public Continue() {
045      this(MESSAGE);
046   }
047
048   /**
049    * Constructor using custom message.
050    * @param message Message to send as the response.
051    */
052   public Continue(String message) {
053      super(message);
054   }
055}