////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2017 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 Simon Grätzer
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_REST_HANDLER_REST_COLLECTION_HANDLER_H
#define ARANGOD_REST_HANDLER_REST_COLLECTION_HANDLER_H 1

#include "RestHandler/RestVocbaseBaseHandler.h"
#include "Transaction/Methods.h"
#include "VocBase/Methods/Collections.h"

namespace arangodb {

class LogicalCollection;

class RestCollectionHandler : public arangodb::RestVocbaseBaseHandler {
 public:
  RestCollectionHandler(application_features::ApplicationServer&,
                        GeneralRequest*, GeneralResponse*);

 public:
  char const* name() const override final { return "RestCollectionHandler"; }
  RequestLane lane() const override final { return RequestLane::CLIENT_SLOW; }
  RestStatus execute() override final;
  
  void shutdownExecute(bool isFinalized) noexcept override final;

 protected:
  void collectionRepresentation(std::string const& name, bool showProperties,
                                bool showFigures, bool showCount, bool detailedCount);

  void collectionRepresentation(LogicalCollection& coll, bool showProperties,
                                bool showFigures, bool showCount, bool detailedCount);

  void collectionRepresentation(methods::Collections::Context& ctxt, bool showProperties,
                                bool showFigures, bool showCount, bool detailedCount);

  futures::Future<futures::Unit> collectionRepresentationAsync(
      methods::Collections::Context& ctxt, bool showProperties,
      bool showFigures, bool showCount, bool detailedCount);

  virtual Result handleExtraCommandPut(LogicalCollection& coll, std::string const& command,
                                       velocypack::Builder& builder) = 0;

 private:
  RestStatus standardResponse();
  void initializeTransaction(LogicalCollection&);

 private:
  RestStatus handleCommandGet();
  void handleCommandPost();
  RestStatus handleCommandPut();
  void handleCommandDelete();

 private:
  VPackBuilder _builder;
  std::unique_ptr<transaction::Methods> _activeTrx;
  std::unique_ptr<methods::Collections::Context> _ctxt;
};

}  // namespace arangodb

#endif