//////////////////////////////////////////////////////////////////////////////// /// @brief document request handler /// /// @file /// /// DISCLAIMER /// /// Copyright 2004-2013 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 triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2010-2013, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef TRIAGENS_REST_HANDLER_REST_DOCUMENT_HANDLER_H #define TRIAGENS_REST_HANDLER_REST_DOCUMENT_HANDLER_H 1 #include "RestHandler/RestVocbaseBaseHandler.h" // ----------------------------------------------------------------------------- // --SECTION-- class RestDocumentHandler // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ArangoDB /// @{ //////////////////////////////////////////////////////////////////////////////// namespace triagens { namespace arango { //////////////////////////////////////////////////////////////////////////////// /// @brief document request handler //////////////////////////////////////////////////////////////////////////////// class RestDocumentHandler : public RestVocbaseBaseHandler { //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ArangoDB /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// @brief constructor //////////////////////////////////////////////////////////////////////////////// RestDocumentHandler (rest::HttpRequest* request, struct TRI_vocbase_s* vocbase); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- Handler methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ArangoDB /// @{ //////////////////////////////////////////////////////////////////////////////// public: //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// bool isDirect (); //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// string const& queue () const; //////////////////////////////////////////////////////////////////////////////// /// {@inheritDoc} //////////////////////////////////////////////////////////////////////////////// status_e execute (); //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------------- // --SECTION-- protected methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @addtogroup ArangoDB /// @{ //////////////////////////////////////////////////////////////////////////////// protected: //////////////////////////////////////////////////////////////////////////////// /// @brief get collection type //////////////////////////////////////////////////////////////////////////////// virtual TRI_col_type_e getCollectionType () const { return TRI_COL_TYPE_DOCUMENT; } //////////////////////////////////////////////////////////////////////////////// /// @brief creates a document //////////////////////////////////////////////////////////////////////////////// virtual bool createDocument (); //////////////////////////////////////////////////////////////////////////////// /// @brief reads a single or all documents //////////////////////////////////////////////////////////////////////////////// virtual bool readDocument (); //////////////////////////////////////////////////////////////////////////////// /// @brief reads a single document //////////////////////////////////////////////////////////////////////////////// virtual bool readSingleDocument (bool generateBody); //////////////////////////////////////////////////////////////////////////////// /// @brief reads all documents //////////////////////////////////////////////////////////////////////////////// virtual bool readAllDocuments (); //////////////////////////////////////////////////////////////////////////////// /// @brief reads a single document head //////////////////////////////////////////////////////////////////////////////// virtual bool checkDocument (); //////////////////////////////////////////////////////////////////////////////// /// @brief replaces a document //////////////////////////////////////////////////////////////////////////////// virtual bool replaceDocument (); //////////////////////////////////////////////////////////////////////////////// /// @brief updates a document //////////////////////////////////////////////////////////////////////////////// virtual bool updateDocument (); //////////////////////////////////////////////////////////////////////////////// /// @brief helper function for replace and update //////////////////////////////////////////////////////////////////////////////// virtual bool modifyDocument (bool); //////////////////////////////////////////////////////////////////////////////// /// @brief deletes a document //////////////////////////////////////////////////////////////////////////////// virtual bool deleteDocument (); }; } } //////////////////////////////////////////////////////////////////////////////// /// @} //////////////////////////////////////////////////////////////////////////////// #endif // Local Variables: // mode: outline-minor // outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}" // End: