IJobSource.hpp

/*
 * IJobSource.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_I_JOB_SOURCE_HPP
#define LAUNCHER_PLUGINS_I_JOB_SOURCE_HPP
 
#include <set>
 
#include <Error.hpp>
#include <api/Job.hpp>
#include <api/ResponseTypes.hpp>
#include <api/stream/AbstractOutputStream.hpp>
#include <api/stream/AbstractResourceStream.hpp>
#include <jobs/AbstractJobRepository.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 api {
 
struct ContainerConfiguration
{
   ContainerConfiguration() :
      AllowUnknownImages(false),
      SupportsContainers(false)
   {
   }
 
   bool AllowUnknownImages;
 
   std::set<std::string> ContainerImages;
 
   std::string DefaultImage;
 
   bool SupportsContainers;
};
 
struct JobSourceConfiguration
{
   ContainerConfiguration ContainerConfig;
 
   JobConfigList CustomConfig;
 
   PlacementConstraintList PlacementConstraints;
 
   std::set<std::string> Queues;
 
   ResourceLimitList ResourceLimits;
};
 
class IJobSource
{
public:
   virtual ~IJobSource() = default;
 
   virtual Error initialize() = 0;
 
   virtual bool cancelJob(JobPtr in_job, bool& out_isComplete, std::string& out_statusMessage) = 0;
 
   virtual Error getConfiguration(const system::User& in_user, JobSourceConfiguration& out_configuration) const = 0;
 
   virtual Error getNetworkInfo(JobPtr in_job, NetworkInfo& out_networkInfo) const = 0;
 
   virtual bool killJob(JobPtr in_job, bool& out_isComplete, std::string& out_statusMessage) = 0;
 
   virtual bool resumeJob(JobPtr in_job, bool& out_isComplete, std::string& out_statusMessage) = 0;
 
   virtual bool stopJob(JobPtr in_job, bool& out_isComplete, std::string& out_statusMessage) = 0;
 
   virtual bool suspendJob(JobPtr in_job, bool& out_isComplete, std::string& out_statusMessage) = 0;
 
   virtual Error submitJob(JobPtr io_job, bool& out_wasInvalidRequest) const = 0;
 
   virtual Error createOutputStream(
      OutputType in_outputType,
      JobPtr in_job,
      AbstractOutputStream::OnOutput in_onOutput,
      AbstractOutputStream::OnComplete in_onComplete,
      AbstractOutputStream::OnError in_onError,
      OutputStreamPtr& out_outputStream) = 0;
 
   virtual Error createResourceStream(
      ConstJobPtr in_job,
      comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator,
      AbstractResourceStreamPtr& out_resourceStream) = 0;
 
protected:
   IJobSource(jobs::JobRepositoryPtr in_jobRepository, jobs::JobStatusNotifierPtr in_jobStatusNotifier) :
      m_jobRepository(std::move(in_jobRepository)),
      m_jobStatusNotifier(std::move(in_jobStatusNotifier))
   {
   }
 
   jobs::JobRepositoryPtr m_jobRepository;
 
   jobs::JobStatusNotifierPtr m_jobStatusNotifier;
};
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
#endif