ISoftwareUpdateService.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Rsc/Commons/Rsc.hpp"
#include "Arp/Base/Rsc/Commons/IRscService.hpp"
#include <vector>
#include "Arp/Base/Rsc/Commons/RscSecureString.hxx"
#include "Arp/Base/Rsc/Commons/RscString.hxx"
#include "Arp/Services/SoftwareUpdate/Services/SoftwareUpdateStatus.hpp"
#include "Arp/Services/SoftwareUpdate/Services/SoftwareVersionFileType.hpp"
#include "Arp/Services/SoftwareUpdate/Services/SoftwareVersionType.hpp"
#include "Arp/Services/SoftwareUpdate/Services/StatusCode.hpp"
#include "Arp/Services/SoftwareUpdate/Services/TransferStatus.hpp"
#include "Arp/Services/SoftwareUpdate/Services/UpdateBehavior.hpp"
#include "Arp/Services/SoftwareUpdate/Services/UpdaterCapabilities.hpp"
 
// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ISoftwareUpdateService.cs
 
namespace Arp::Services::SoftwareUpdate::Services
{
 
using namespace Arp::Base::Rsc::Commons;
 
class ARP_EXPORT ISoftwareUpdateService : public IRscService
{
public: // usings
    using Ptr = std::shared_ptr<ISoftwareUpdateService>;
 
public: // construction/destruction
    ISoftwareUpdateService(void) = default;
 
public: // static policy operation
    static IRscServiceProxyFactory& GetProxyFactory(void);
 
public: // abstract operations
    virtual std::vector<RscString<64>> GetUpdaterList() = 0;
 
    virtual StatusCode                 GetUpdaterCapabilities(const RscString<64>& updaterName, UpdaterCapabilities& capabilities) = 0;
 
    virtual StatusCode                 GetUpdateBehavior(const RscString<64>& updaterName, const RscString<512>& componentId, const RscString<512>& manufacturerUri, const RscString<512>& softwareRevision, const std::vector<RscString<512>>& patchIdentifiers, UpdateBehavior& updateBehavior) = 0;
 
    virtual StatusCode                 GetStatus(const RscString<64>& updaterName, const RscString<512>& componentId, SoftwareUpdateStatus& status) = 0;
 
    virtual StatusCode                 GetSoftwareVersion(const RscString<64>& updaterName, const RscString<512>& componentId, SoftwareVersionFileType fileType, SoftwareVersionType& version) = 0;
 
    virtual StatusCode                 SetSoftwarePackage(const RscString<64>& updaterName, const RscString<512>& componentId, SoftwareVersionFileType fileType, const RscString<512>& fileName, boolean async, RscString<512>& errorMessage) = 0;
 
    virtual StatusCode                 GetSoftwarePackage(const RscString<64>& updaterName, const RscString<512>& componentId, SoftwareVersionFileType fileType, const RscString<512>& fileName, boolean async, RscString<512>& errorMessage) = 0;
 
    virtual StatusCode                 GetTransferStatus(const RscString<64>& updaterName, const RscString<512>& componentId, TransferStatus& status) = 0;
 
    virtual StatusCode                 Prepare(const RscString<64>& updaterName, const RscString<512>& componentId) = 0;
 
    virtual StatusCode                 ForcePrepare(const RscString<64>& updaterName, const RscString<512>& componentId) = 0;
 
    virtual StatusCode                 Abort(const RscString<64>& updaterName, const RscString<512>& componentId) = 0;
 
    virtual StatusCode                 ResumePrepare(const RscString<64>& updaterName, const RscString<512>& componentId) = 0;
 
    virtual StatusCode                 SetUpdateKey(const RscString<64>& updaterName, const RscString<512>& componentId, const RscSecureString<512>& updateKey) = 0;
 
    virtual StatusCode                 SetInstallationDelay(const RscString<64>& updaterName, const RscString<512>& componentId, int64 installationDelay) = 0;
 
    virtual StatusCode                 GetInstallationDelay(const RscString<64>& updaterName, const RscString<512>& componentId, int64& installationDelay) = 0;
 
    virtual StatusCode                 InstallSoftwarePackage(const RscString<64>& updaterName, const RscString<512>& componentId, const RscString<512>& manufacturerUri, const RscString<512>& softwareRevision, const std::vector<RscString<512>>& patchIdentifiers, boolean autoResumePrepareForUpdate) = 0;
 
    virtual StatusCode                 ResumeInstall(const RscString<64>& updaterName, const RscString<512>& componentId) = 0;
 
    virtual int64                      GetConfirmationTimeout() = 0;
 
    virtual StatusCode                 SetConfirmationTimeout(int64 timeout) = 0;
 
    virtual StatusCode                 Confirm() = 0;
 
    virtual StatusCode                 Clear(const RscString<64>& updaterName, const RscString<512>& componentId, SoftwareVersionFileType fileType) = 0;
};
 
} // end of namespace Arp::Services::SoftwareUpdate::Services