mirror of https://gitee.com/bigwinds/arangodb
116 lines
3.7 KiB
C++
116 lines
3.7 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
|
|
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// 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
|
|
///
|
|
/// 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.
|
|
///
|
|
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Dr. Frank Celler
|
|
/// @author Achim Brandt
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_REST_HTTP_RESPONSE_H
|
|
#define ARANGODB_REST_HTTP_RESPONSE_H 1
|
|
|
|
#include "Rest/GeneralResponse.h"
|
|
|
|
#include "Basics/StringBuffer.h"
|
|
|
|
namespace arangodb {
|
|
class HttpResponse : public GeneralResponse {
|
|
public:
|
|
static bool HIDE_PRODUCT_HEADER;
|
|
static std::string const BATCH_ERROR_HEADER;
|
|
|
|
public:
|
|
explicit HttpResponse(ResponseCode code);
|
|
|
|
public:
|
|
bool isHeadResponse() const { return _isHeadResponse; }
|
|
bool isChunked() const { return _isChunked; }
|
|
|
|
enum ConnectionType {
|
|
CONNECTION_NONE,
|
|
CONNECTION_KEEP_ALIVE,
|
|
CONNECTION_CLOSE
|
|
};
|
|
|
|
enum ContentType {
|
|
CONTENT_TYPE_CUSTOM, // use Content-Type from _headers
|
|
CONTENT_TYPE_JSON, // application/json
|
|
CONTENT_TYPE_VPACK, // application/x-velocypack
|
|
CONTENT_TYPE_TEXT, // text/plain
|
|
CONTENT_TYPE_HTML, // text/html
|
|
CONTENT_TYPE_DUMP // application/x-arango-dump
|
|
};
|
|
|
|
public:
|
|
using GeneralResponse::setHeader;
|
|
|
|
void setCookie(std::string const& name, std::string const& value,
|
|
int lifeTimeSeconds, std::string const& path,
|
|
std::string const& domain, bool secure, bool httpOnly);
|
|
|
|
// In case of HEAD request, no body must be defined. However, the response
|
|
// needs to know the size of body.
|
|
void headResponse(size_t);
|
|
|
|
// Returns a reference to the body. This reference is only valid as long as
|
|
// http response exists. You can add data to the body by appending
|
|
// information to the string buffer. Note that adding data to the body
|
|
// invalidates any previously returned header. You must call header
|
|
// again.
|
|
basics::StringBuffer& body() { return _body; }
|
|
size_t bodySize() const;
|
|
|
|
/// @brief set type of connection
|
|
void setConnectionType(ConnectionType type) { _connectionType = type; }
|
|
|
|
/// @brief set content-type
|
|
void setContentType(ContentType type) { _contentType = type; }
|
|
|
|
/// @brief set content-type from a string. this should only be used in
|
|
/// cases when the content-type is user-defined
|
|
void setContentType(std::string const& contentType) {
|
|
_headers[arangodb::StaticStrings::ContentTypeHeader] = contentType;
|
|
_contentType = CONTENT_TYPE_CUSTOM;
|
|
}
|
|
|
|
void setContentType(std::string&& contentType) {
|
|
_headers[arangodb::StaticStrings::ContentTypeHeader] = std::move(contentType);
|
|
_contentType = CONTENT_TYPE_CUSTOM;
|
|
}
|
|
|
|
// you should call writeHeader only after the body has been created
|
|
void writeHeader(basics::StringBuffer*);
|
|
|
|
private:
|
|
// the body must already be set. deflate is then run on the existing body
|
|
int deflate(size_t = 16384);
|
|
|
|
private:
|
|
ConnectionType _connectionType;
|
|
ContentType _contentType;
|
|
bool _isHeadResponse;
|
|
bool _isChunked; // TODO: remove
|
|
std::vector<std::string> _cookies;
|
|
basics::StringBuffer _body;
|
|
size_t _bodySize;
|
|
};
|
|
}
|
|
|
|
#endif
|