AbstractJobRepository.hpp

/*
 * AbstractJobRepository.hpp
 *
 * Copyright (C) 2020 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * 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_JOB_REPOSITORY_HPP
#define LAUNCHER_PLUGINS_JOB_REPOSITORY_HPP
 
#include <Noncopyable.hpp>
 
#include <PImpl.hpp>
#include <api/Job.hpp>
#include <jobs/JobStatusNotifier.hpp>
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
class User;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace jobs {
 
class AbstractJobRepository : public Noncopyable, public std::enable_shared_from_this<AbstractJobRepository>
{
public:
   explicit AbstractJobRepository(JobStatusNotifierPtr in_jobStatusNotifier);
 
   virtual ~AbstractJobRepository() = default;
 
   void addJob(const api::JobPtr& in_job);
 
   api::JobPtr getJob(const std::string& in_jobId, const system::User& in_user = system::User()) const;
 
   api::JobList getJobs(const system::User& in_use = system::User()) const;
 
   Error initialize();
 
   void removeJob(const std::string& in_jobId);
 
private:
   virtual Error loadJobs(api::JobList& out_jobs) const = 0;
 
   virtual void onJobAdded(const api::JobPtr& in_job);
 
   virtual void onJobRemoved(const api::JobPtr& in_job);
 
   virtual Error onInitialize();
 
   // The private implementation of AbstractJobRepository.
   PRIVATE_IMPL(m_impl);
};
 
typedef std::shared_ptr<AbstractJobRepository> JobRepositoryPtr;
 
} // namespace jobs
} // namespace launcher_plugins
} // namespace rstudio
 
#endif