StorageObject.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
 *
 * This software is dual-licensed to you under the MIT License (MIT) and
 * the Universal Permissive License (UPL). See the LICENSE file in the root
 * directory for license terms. You may choose either license, or both.
 */

#pragma once

#include <string>
#include <VirtualDevice.hpp>
#include <ExternalObject.hpp>
#include "iotcs_storage_object.h"
#include <Exception.hpp>
#include <time.h>

#ifdef __MBED__
#include "mbed.h"
#endif

namespace iotdcl {
    class StorageObject;
    enum SyncStatus {
        IN_SYNC = 0,

        SYNC_FAILED,
        
        NOT_IN_SYNC,

        SYNC_PENDING
    };

    template<class V> class SyncEvent {
        public:
            virtual V* getVirtualDevice() const = 0;

            virtual const std::string& getName() const = 0;

            virtual StorageObject* getSource() const = 0;

            virtual ~SyncEvent() {};
    };

    class SyncCallback {
        public:
            virtual void onSync(const SyncEvent<VirtualDevice>& event) const = 0;

            virtual ~SyncCallback() {
            }
    };

    class StorageObject : public ExternalObject {
        public:
            virtual ~StorageObject();

            virtual const std::string& getName() const;

            virtual const std::string& getType() const;

            virtual const std::string& getEncoding() const;

            virtual long getLength() const;

            virtual time_t getDate() const;

            virtual SyncStatus getSyncStatus() const;

            virtual const std::string& getInputPath() const;

            virtual void setInputPath(const std::string& inputPath) throw (GeneralException, std::invalid_argument);

            virtual const std::string& getOutputPath() const;

            virtual void setOutputPath(const std::string& outputPath) throw (GeneralException, std::invalid_argument);

            virtual void  setCustomMetadata(const std::string& key, const std::string& value) throw (std::invalid_argument);
            virtual void sync() throw (GeneralException, std::invalid_argument);

            virtual void setOnSync(const SyncCallback *callback);

            virtual const std::string& getURI();
#ifndef IOTCS_DOXYGEN
        protected:
            VirtualDevice *vd;
            void setVirtualDevice(VirtualDevice *vd);
            iotcs_storage_object_handle c_handler() const;
            StorageObject() {};
            std::string *name;
            std::string *outPath;
            std::string *inPath;
            std::string *type;
            std::string *encoding;
            friend VirtualDevice;
            friend Alert;
            friend Data;
#endif
    };
};