////////////////////////////////////////////////////////////////////////////////
/// 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
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_REST_HANDLER_REST_BASE_HANDLER_H
#define ARANGOD_REST_HANDLER_REST_BASE_HANDLER_H 1

#include "GeneralServer/RestHandler.h"

#include "Rest/GeneralResponse.h"

namespace arangodb {
class TransactionContext;

namespace velocypack {
struct Options;
class Slice;
}

class RestBaseHandler : public rest::RestHandler {
 public:
  explicit RestBaseHandler(GeneralRequest*, GeneralResponse*);

  void handleError(basics::Exception const&) override;

 public:
  // generates a result from VelocyPack
  void generateResult(GeneralResponse::ResponseCode,
                      arangodb::velocypack::Slice const& slice);

  // generates a result from VelocyPack
  void generateResult(GeneralResponse::ResponseCode,
                      arangodb::velocypack::Slice const& slice,
                      std::shared_ptr<arangodb::TransactionContext> context);

  // generates an error
  void generateError(GeneralResponse::ResponseCode, int);

  // generates an error
  void generateError(GeneralResponse::ResponseCode, int, std::string const&);

  // generates an out of memory error
  void generateOOMError();

  // generates a canceled message
  void generateCanceled();

 protected:
  // write result back to client
  void writeResult(arangodb::velocypack::Slice const& slice,
                   arangodb::velocypack::Options const& options);
};
}

#endif