ifmeservermountpoint.h

Go to the documentation of this file.

#ifndef _IFMESERVERMOUNTPOINT_H
#define _IFMESERVERMOUNTPOINT_H

#include <fmeservertypes.h>
#include <ifmeservervector.h>

class IFMEServerPath;
class IFMEServerPropertyAccessor;
class IFMEServerStatus;
class IFMEServerString;
class IFMEServerStringArray;
class IFMEServerTransferCallback;

//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerMountPoint
{
public:
   // -----------------------------------------------------------------------
   virtual void getName(IFMEServerString& name) const = 0;
   
   // -----------------------------------------------------------------------
   virtual void getDisplayName(IFMEServerString& displayName) const = 0;

   // -----------------------------------------------------------------------
   virtual void getDescription(IFMEServerString& description) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* exists(const IFMEServerPath& path,
                                    FME_Boolean& exists) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* download(const IFMEServerPath& src,
                                      const IFMEServerString& dest,
                                      FME_Boolean& exists,
                                      IFMEServerTransferCallback* callback) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* upload(const IFMEServerString& src,
                                    const IFMEServerPath& path,
                                    IFMEServerTransferCallback* callback) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* copy(const IFMEServerPath& src,
                                  const IFMEServerPath& dest) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* move(const IFMEServerPath& src,
                                  const IFMEServerPath& dest) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* get(const IFMEServerPath& path,
                                 IFMEServerFileInfo& fileInfo,
                                 FME_Boolean& exists) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* get(const IFMEServerPath& path,
                                 const IFMEServerStringArray* directives,
                                 IFMEServerFileInfo& fileInfo,
                                 FME_Boolean& exists) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* list(const IFMEServerPath& path,
                                  IFMEServerFileInfoVector& fileInfos) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* list(const IFMEServerPath& path,
                                  const IFMEServerStringArray* directives,
                                  IFMEServerFileInfoVector& fileInfos) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* make(const IFMEServerPath& path) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* remove(const IFMEServerPath& path,
                                    FME_Boolean& removed) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerPropertyAccessor* getPropertyAccessor() const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerPath* createPath(const IFMEServerString& dirpath,
                                      const IFMEServerString& name) const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerPath* createPath(const IFMEServerString& path) const = 0;

   // -----------------------------------------------------------------------
   virtual void destroyPath(IFMEServerPath*& path) const = 0;

protected:

   // -----------------------------------------------------------------------
   // No one should be creating an instance of this directly, so we
   // make the constructor protected.
   IFMEServerMountPoint() {}

   // -----------------------------------------------------------------------
   // No one should be destroying an instance of this directly, so we
   // make the destructor protected.
   virtual ~IFMEServerMountPoint() {}

private:

   // -----------------------------------------------------------------------
   // The copy constructor is not implemented.
   IFMEServerMountPoint(const IFMEServerMountPoint &other);

   // -----------------------------------------------------------------------
   // The assignment operator is not implemented. 
   IFMEServerMountPoint &operator=(const IFMEServerMountPoint &other);

};

#endif