1
0
Fork 0
arangodb/arangod/Cluster/MaintenanceRestHandler.h

89 lines
2.7 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2018 ArangoDB 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 Kaveh Vahedipour
/// @author Matthew Von-Maszewski
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGOD_CLUSTER_MAINTENANCE_REST_HANDLER
#define ARANGOD_CLUSTER_MAINTENANCE_REST_HANDLER 1
#include "Cluster/Action.h"
#include "RestHandler/RestBaseHandler.h"
namespace arangodb {
////////////////////////////////////////////////////////////////////////////////
/// @brief Object that directs processing of one user maintenance requests
////////////////////////////////////////////////////////////////////////////////
class MaintenanceRestHandler : public RestBaseHandler {
public:
MaintenanceRestHandler(application_features::ApplicationServer&,
GeneralRequest*, GeneralResponse*);
public:
char const* name() const override { return "MaintenanceRestHandler"; }
RequestLane lane() const override final {
return RequestLane::CLUSTER_INTERNAL;
}
/// @brief Performs routing of request to appropriate subroutines
RestStatus execute() override;
//
// Accessors
//
/// @brief retrieve parsed action description
maintenance::ActionDescription const& getActionDesc() const {
return *_actionDesc;
};
/// @brief retrieve unparsed action properties
VPackBuilder const& getActionProp() const {
return *(_actionDesc->properties());
};
protected:
/// @brief POST conrol maintenance feature
RestStatus postAction();
/// @brief PUT method adds an Action to the worklist (or executes action
/// directly)
void putAction();
/// @brief GET method returns worklist
void getAction();
/// @brief DELETE method shifts non-finished action to Failed list.
/// (finished actions are untouched)
void deleteAction();
/// @brief internal routine to convert PUT body into _actionDesc and
/// _actionProp
bool parsePutBody(VPackSlice const& parameters);
protected:
std::shared_ptr<maintenance::ActionDescription> _actionDesc;
};
} // namespace arangodb
#endif