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.Ok.*;
016
017import org.apache.juneau.http.annotation.*;
018
019/**
020 * Represents an <code>HTTP 200 OK</code> response.
021 *
022 * <p>
023 * Standard response for successful HTTP requests. The actual response will depend on the request method used.
024 * In a GET request, the response will contain an entity corresponding to the requested resource.
025 * In a POST request, the response will contain an entity describing or containing the result of the action.
026 */
027@Response(code=CODE, description=MESSAGE)
028public class Ok extends HttpResponse {
029
030   /** HTTP status code */
031   public static final int CODE = 200;
032
033   /** Default message */
034   public static final String MESSAGE = "OK";
035
036   /** Reusable instance. */
037   public static final Ok INSTANCE = new Ok();
038   /** Reusable instance. */
039   public static final Ok OK = new Ok();
040
041   /**
042    * Constructor using HTTP-standard message.
043    */
044   public Ok() {
045      this(MESSAGE);
046   }
047
048   /**
049    * Constructor using custom message.
050    * @param message Message to send as the response.
051    */
052   public Ok(String message) {
053      super(message);
054   }
055}