blob: b0408c4e8a4b1e89c2b1535065db454e9d82d293 [file] [log] [blame]
// Copyright 2015 The Android Open Source Project
// Licensed 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include <base/macros.h>
#include <brillo/streams/stream.h>
#include <libwebserv/export.h>
namespace base {
class Value;
} // namespace base
namespace libwebserv {
class ProtocolHandler;
// Response class is a proxy for HTTP response used by the request handler
// to provide response HTTP headers and data.
class LIBWEBSERV_EXPORT Response {
virtual ~Response() = default;
// Adds a single HTTP response header to the response.
virtual void AddHeader(const std::string& header_name,
const std::string& value);
// Adds number of HTTP response headers to the response.
virtual void AddHeaders(
const std::vector<std::pair<std::string, std::string>>& headers) = 0;
// Generic reply method for sending arbitrary binary data response.
virtual void Reply(int status_code,
brillo::StreamPtr data_stream,
const std::string& mime_type) = 0;
// Reply with text body.
virtual void ReplyWithText(int status_code,
const std::string& text,
const std::string& mime_type);
// Reply with JSON object. The content type will be "application/json".
virtual void ReplyWithJson(int status_code, const base::Value* json);
// Special form for JSON response for simple objects that have a flat
// list of key-value pairs of string type.
virtual void ReplyWithJson(int status_code,
const std::map<std::string, std::string>& json);
// Issue a redirect response, so the client browser loads a page at
// the URL specified in |redirect_url|. If this is not an external URL,
// it must be an absolute path starting at the root "/...".
virtual void Redirect(int status_code, const std::string& redirect_url);
// Send a plain text response (with no Content-Type header).
// Usually used with error responses. |error_text| must be plain text.
virtual void ReplyWithError(int status_code, const std::string& error_text);
// Send "404 Not Found" response.
virtual void ReplyWithErrorNotFound();
} // namespace libwebserv