Request.hpp

/*
 * Request.hpp
 *
 * Copyright (C) 2019-20 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_REQUEST_HPP
#define LAUNCHER_PLUGINS_REQUEST_HPP
 
#include <Noncopyable.hpp>
 
#include <set>
#include <vector>
 
#include <PImpl.hpp>
#include <Optional.hpp>
#include <api/Job.hpp>
#include <api/stream/AbstractOutputStream.hpp>
#include <system/DateTime.hpp>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
namespace json {
 
class Object;
 
} // namespace json
 
namespace system {
 
class User;
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace api {
 
class Request : public Noncopyable
{
public:
   enum class Type
   {
      HEARTBEAT               = 0,
 
      BOOTSTRAP               = 1,
 
      SUBMIT_JOB              = 2,
 
      GET_JOB                 = 3,
 
      GET_JOB_STATUS          = 4,
 
      CONTROL_JOB             = 5,
 
      GET_JOB_OUTPUT          = 6,
 
      GET_JOB_RESOURCE_UTIL   = 7,
 
      GET_JOB_NETWORK         = 8,
 
      GET_CLUSTER_INFO        = 9,
 
      INVALID
   };
 
   virtual ~Request() = default;
 
   static Error fromJson(const json::Object& in_requestJson, std::shared_ptr<Request>& out_request);
 
   uint64_t getId() const;
 
   Type getType() const;
 
protected:
   explicit Request(Type in_requestType, const json::Object& in_requestJson);
 
   // The private implementation of Request
   PRIVATE_IMPL(m_baseImpl);
};
 
class UserRequest : public Request
{
public:
   const system::User& getUser() const;
 
   const std::string& getRequestUsername() const;
 
protected:
   explicit UserRequest(Request::Type in_type, const json::Object& in_requestJson);
 
private:
   // The private implementation of UserRequest.
   PRIVATE_IMPL(m_userImpl);
 
   friend class Request;
};
 
class JobIdRequest : public UserRequest
{
public:
   const std::string& getJobId() const;
   const std::string& getEncodedJobId() const;
 
protected:
   JobIdRequest(Request::Type in_type, const json::Object& in_requestJson);
 
private:
   // The private implementation of JobIdRequest.
   PRIVATE_IMPL(m_jobIdImpl);
};
 
class BootstrapRequest final : public Request
{
public:
   int getMajorVersion() const;
 
   int getMinorVersion() const;
 
   int getPatchNumber() const;
 
private:
   explicit BootstrapRequest(const json::Object& in_requestJson);
 
   // The private implementation of BootstrapRequest.
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class SubmitJobRequest final : public UserRequest
{
public:
   JobPtr getJob();
 
private:
   explicit SubmitJobRequest(const json::Object& in_requestJson);
 
   // The private implementation of SubmitJobRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class JobStateRequest final : public JobIdRequest
{
public:
   Error getEndTime(Optional<system::DateTime>& out_endTime) const;
 
   const Optional<std::set<std::string> >& getFieldSet() const;
 
   Error getStartTime(Optional<system::DateTime>& out_endTime) const;
 
   Error getStatusSet(Optional<std::set<Job::State> >& out_statuses) const;
 
   const Optional<std::set<std::string> >& getTagSet() const;
 
private:
   explicit JobStateRequest(const json::Object& in_requestJson);
 
   // The private implementation of JobStateRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class JobStatusRequest final : public JobIdRequest
{
public:
   bool isCancelRequest() const;
 
private:
   explicit JobStatusRequest(const json::Object& in_requestJson);
 
   // The private implementation of JobStatusRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class ControlJobRequest final : public JobIdRequest
{
public:
   enum class Operation
   {
      FIRST = 0,
      SUSPEND = 0,
 
      RESUME = 1,
 
      STOP = 2,
 
      KILL = 3,
 
      CANCEL = 4,
 
      INVALID
   };
 
   Operation getOperation() const;
 
private:
   explicit ControlJobRequest(const json::Object& in_requestJson);
 
   // The private implementation of ControlJobRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class OutputStreamRequest final : public JobIdRequest
{
public:
 
   OutputType getStreamType() const;
 
   bool isCancelRequest() const;
 
private:
   explicit OutputStreamRequest(const json::Object& in_requestJson);
 
   // The private implementation of OutputStreamRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
 
};
 
class ResourceUtilStreamRequest final : public JobIdRequest
{
public:
   bool isCancelRequest() const;
 
private:
   explicit ResourceUtilStreamRequest(const json::Object& in_requestJson);
 
   // The private implementation of ResourceUtilStreamRequest
   PRIVATE_IMPL(m_impl);
 
   friend class Request;
};
 
class NetworkRequest final : public JobIdRequest
{
private:
   explicit NetworkRequest(const json::Object& in_requestJson);
 
   friend class Request;
};
 
std::ostream& operator<<(std::ostream& in_ostream, Request::Type in_type);
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
#endif