src/plugin-interface/plugin-interface.hpp

   1 /*
   2 ==================================================================================
   3
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 */
  19
  20 #pragma once
  21 #ifndef POLICY_BASE
  22 #define POLICY_BASE
  23
  24 #include <iostream>
  25 #include <vector>
  26
  27 // Base abstract Class that provides interface to  manage plugins.
  28 //  Interface for following actions
  29 // -- configure policy
  30 // -- get policy
  31 // -- get metrics.
  32
  33 // All plugins should be instantiated within derivatives of this class
  34
  35 // Direct execution of the plugin on data is done by the message
  36 // operator class.
  37
  38 class Policy
  39 {
  40 public:
  41   virtual bool setPolicy(const char *, int, std::string &) = 0;
  42   virtual bool getPolicy(const char *, int , std::string & ) = 0;
  43   virtual int getMetrics(std::vector<std::string>  & ) = 0;
  44   virtual std::string getName(void) = 0;
  45   virtual std::string  get_error(void) const = 0;
  46   virtual ~Policy(void) = 0;
  47
  48
  49
  50
  51
  52
  53 private:
  54
  55   std::string _error;
  56
  57
  58 };
  59
  60 #endif