mirror of
https://github.com/OpenNebula/one.git
synced 2024-12-21 09:33:53 +03:00
105 lines
3.5 KiB
C++
105 lines
3.5 KiB
C++
/* -------------------------------------------------------------------------- */
|
|
/* Copyright 2002-2024, OpenNebula Project, OpenNebula Systems */
|
|
/* */
|
|
/* 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. */
|
|
/* -------------------------------------------------------------------------- */
|
|
|
|
#ifndef HOOK_API_H_
|
|
#define HOOK_API_H_
|
|
|
|
#include <string>
|
|
#include "HookImplementation.h"
|
|
|
|
class HookPool;
|
|
class Hook;
|
|
|
|
class ParamList;
|
|
class RequestAttributes;
|
|
|
|
class HookAPI : public HookImplementation
|
|
{
|
|
public:
|
|
/**
|
|
* Function to build a XML message for an API hook
|
|
*/
|
|
static std::string format_message(const std::string& method,
|
|
const ParamList& paramList,
|
|
const RequestAttributes& att);
|
|
|
|
/**
|
|
* Check if an api call is supported or not.
|
|
* @param api call
|
|
*
|
|
* @return true if the call exists, false otherwise
|
|
*/
|
|
static bool supported_call(const std::string& api_call);
|
|
|
|
private:
|
|
friend class HookPool;
|
|
friend class Hook;
|
|
|
|
// *************************************************************************
|
|
// Constructor/Destructor
|
|
// *************************************************************************
|
|
HookAPI() = default;
|
|
|
|
HookAPI(const std::string& _call): call(_call) {};
|
|
|
|
virtual ~HookAPI() = default;
|
|
|
|
/**
|
|
* Check if type dependent attributes are well defined.
|
|
* @param tmpl pointer to the Hook template
|
|
* @param error_str string with error information
|
|
* @return 0 on success
|
|
*/
|
|
int parse_template(Template *tmpl, std::string& error_str) override;
|
|
|
|
/**
|
|
* Rebuilds the object from a template
|
|
* @param tmpl The template
|
|
*
|
|
* @return 0 on success, -1 otherwise
|
|
*/
|
|
int from_template(const Template * tmpl, std::string& error) override;
|
|
|
|
/* Checks the mandatory template attributes
|
|
* @param tmpl The hook template
|
|
* @param error string describing the error if any
|
|
*
|
|
* @return 0 on success
|
|
*/
|
|
int post_update_template(Template * tmpl, std::string& error) override;
|
|
|
|
/**
|
|
* Check if an api call does exist in the XMLRPC server.
|
|
* @param api call
|
|
*
|
|
* @return true if the call exists, false otherwise
|
|
*/
|
|
bool call_exist(const std::string& api_call);
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Hook API Attributes
|
|
// -------------------------------------------------------------------------
|
|
|
|
/**
|
|
* String representation of the API call
|
|
*/
|
|
std::string call;
|
|
|
|
const static std::string unsupported_calls[];
|
|
};
|
|
|
|
#endif
|