mirror of https://gitee.com/bigwinds/arangodb
138 lines
4.8 KiB
C++
138 lines
4.8 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
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGOD_APPLICATION_SERVER_APPLICATION_FEATURE_H
|
|
#define ARANGOD_APPLICATION_SERVER_APPLICATION_FEATURE_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
|
|
#include "ApplicationServer/ApplicationServer.h"
|
|
|
|
namespace arangodb {
|
|
namespace basics {
|
|
class ProgramOptionsDescription;
|
|
}
|
|
|
|
namespace rest {
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief application server feature
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
class ApplicationFeature {
|
|
private:
|
|
ApplicationFeature(ApplicationFeature const&) = delete;
|
|
ApplicationFeature& operator=(ApplicationFeature const&) = delete;
|
|
|
|
public:
|
|
explicit ApplicationFeature(std::string const& name);
|
|
|
|
virtual ~ApplicationFeature();
|
|
|
|
public:
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the name
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string const& getName() const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets up the options
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual void setupOptions(
|
|
std::map<std::string, basics::ProgramOptionsDescription>&);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief callback after options parsing and config file reading,
|
|
/// before dropping privileges
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool afterOptionParsing(basics::ProgramOptions&);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief prepares the feature
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool prepare();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief prepares the feature
|
|
///
|
|
/// there might be dependencies between features, e.g. F1 depends on F2
|
|
/// F1->prepare() would need to be called after F2->prepare() but this is not
|
|
/// possible. prepare2() gives a feature a second chance to initialize itself.
|
|
/// it is called after all prepare() actions have been finished
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool prepare2();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief starts the feature
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool start();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief opens the feature for business
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual bool open();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief closes the feature
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual void close();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief stops everything
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual void stop();
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief disable feature
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
void disable();
|
|
|
|
protected:
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief feature is disabled
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _disabled;
|
|
|
|
private:
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief name of the feature
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string const _name;
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif
|