AbstractPluginApi.hpp

/*
 * AbstractPluginApi.hpp
 * 
 * Copyright (C) 2019-20 by RStudio, PBC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LAUNCHER_PLUGINS_ABSTRACT_PLUGIN_API_HPP
#define LAUNCHER_PLUGINS_ABSTRACT_PLUGIN_API_HPP
 
#include <Noncopyable.hpp>
 
#include <PImpl.hpp>
#include <comms/AbstractLauncherCommunicator.hpp>
#include <jobs/AbstractJobRepository.hpp>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
namespace api {
 
class IJobSource;
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace api {
 
class AbstractPluginApi : public Noncopyable, public std::enable_shared_from_this<AbstractPluginApi>
{
public:
   virtual ~AbstractPluginApi() = default;
 
   Error initialize();
 
protected:
   explicit AbstractPluginApi(std::shared_ptr<comms::AbstractLauncherCommunicator> in_launcherCommunicator);
 
private:
    virtual jobs::JobRepositoryPtr createJobRepository(
       const jobs::JobStatusNotifierPtr& in_jobStatusNotifier) const = 0;
 
   virtual std::shared_ptr<IJobSource> createJobSource(
      jobs::JobRepositoryPtr in_jobRepository,
      jobs::JobStatusNotifierPtr in_jobStatusNotifier) const = 0;
 
   virtual Error doInitialize() = 0;
 
   // The private implementation of AbstractPluginApi
   PRIVATE_IMPL(m_abstractPluginImpl);
};
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
#endif