ifmeserversession.h

Go to the documentation of this file.

#ifndef _IFMESERVERSESSION_H_
#define _IFMESERVERSESSION_H_

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

class IFMEServerSession;
class IFMEServerConnectionInfo;
class IFMEServerBaseTransformationManager;
class IFMEServerTransformationManager;
class IFMEServerString;
class IFMEServerStringArray;
class IFMEServerTransformationRequest;
class IFMEServerTransformationResult;
class IFMEServerRepositoryManager;
class IFMEServerService;
class IFMEServerWorkspace;
class IFMEServerWorkspaceSummary;
class IFMEServerWorkspaceService;
class IFMEServerStatus;
class IFMEServerRepository;
class IFMEServerCustomFormat;
class IFMEServerCustomTransformer;
class IFMEServerResource;
class IFMEServerPropertyAccessor;
class IFMEServerLogFileInfo;
class IFMEServerTemplate;
class IFMEServerIdentity;
class IFMEServerSecurityManager;
class IFMEServerMountPointManager;

// Now we define the exports.
#ifdef _WIN32

#ifdef FMESERVERAPI_DLL
#define FMESERVER_API __declspec(dllexport)
#else
#define FMESERVER_API __declspec(dllimport)
#endif

#else

#define FMESERVER_API

#endif


//----------------------------------------------------------------------
// Make these entry points "extern C" so that they could easily be
// dynamically loaded

extern "C" {

   //----------------------------------------------------------------------
   // This functions returns a pointer to an FME Server session object.
   // The caller can then access all the member functions provided by
   // the IFMEServerSession class to interact with the FME Server. The
   // returned IFMESession object should only be freed by calling
   // the FME_destroyServerSession method.  These entry points are NOT to be
   // mixed or confused with with the FME C-API entry points 
   // "FME_SessionCreate" and "FME_SessionDestroy".

   FMESERVER_API void FME_createServerSession(IFMEServerSession*& fmeServerSession);

   //----------------------------------------------------------------------
   // This function is used to destroy an FME session created by the
   // FME_createSessionObject call.

   FMESERVER_API void FME_destroyServerSession(IFMEServerSession*& fmeServerSession);

}



//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerSession
{

public:

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* init(const IFMEServerConnectionInfo& connectionInfo,
                                  const IFMEServerStringArray* directives) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerConnectionInfo* createServerConnectionInfo(const IFMEServerString& host,
                                                                FME_UInt16 port,
                                                                const IFMEServerString& userID,
                                                                const IFMEServerString& password) = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerConnectionInfo* createServerConnectionInfo(const IFMEServerString& host,
                                                                FME_UInt16 port,
                                                                const IFMEServerStringArray& directives) = 0;

   // -----------------------------------------------------------------------
   virtual void destroyServerConnectionInfo(IFMEServerConnectionInfo*& pServerConnectionInfo) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* disconnect() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTransformationManager* getTransformationManager() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerRepositoryManager* getRepositoryManager() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerString* createServerString() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyServerString(IFMEServerString*& serverString) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStringArray* createServerStringArray() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyServerStringArray(IFMEServerStringArray*& serverStringArray) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTransformationRequest* createTransformationRequest(const IFMEServerString& subsectionName,
                                                                  const IFMEServerString& path) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTransformationRequest* createTransformationRequest(const IFMEServerString& subsectionName,
                                                                  const IFMEServerString& repositoryName,
                                                                  const IFMEServerString& workspaceName) = 0;

   // -----------------------------------------------------------------------
   //
   //  \return a new IFMEServerTransformationRequest instance */
   virtual IFMEServerTransformationRequest* createTransformationRequest(const IFMEServerString& subsectionName,
                                                                  const IFMEServerString& repositoryName,
                                                                  const IFMEServerWorkspace& workspace) = 0;

   // -----------------------------------------------------------------------
   virtual void destroyTransformationRequest(IFMEServerTransformationRequest*& transformationRequest) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTransformationResult* createTransformationResult() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTransformationResult* createTransformationResult(const IFMEServerString& fmeServerResponse) = 0;

   // -----------------------------------------------------------------------
   virtual void destroyTransformationResult(IFMEServerTransformationResult*& transformationResult) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerService* createService() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerService* createService(const IFMEServerString& name,
                                      const IFMEServerString& displayName,
                                      const IFMEServerString& description,
                                      const IFMEServerString& urlPattern) = 0;

   // -----------------------------------------------------------------------
   virtual void destroyService(IFMEServerService*& service) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerServiceVector* createServiceVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyServiceVector(IFMEServerServiceVector*& serviceVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspace* createWorkspace() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspace(IFMEServerWorkspace*& workspace) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspaceVector* createWorkspaceVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspaceVector(IFMEServerWorkspaceVector*& workspaceVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerRepository* createRepository() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyRepository(IFMEServerRepository*& repository) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerRepositoryVector* createRepositoryVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyRepositoryVector(IFMEServerRepositoryVector*& repositoryVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspaceSummary* createWorkspaceSummary() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspaceSummary(IFMEServerWorkspaceSummary*& workspaceSummary) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspaceSummaryVector* createWorkspaceSummaryVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspaceSummaryVector(IFMEServerWorkspaceSummaryVector*& workspaceSummaryVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspaceService* createWorkspaceService() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspaceService(IFMEServerWorkspaceService*& workspaceService) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerWorkspaceServiceVector* createWorkspaceServiceVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyWorkspaceServiceVector(IFMEServerWorkspaceServiceVector*& workspaceServiceVector) = 0;

   // -----------------------------------------------------------------------
   virtual void destroyServerStatus(IFMEServerStatus*& serverStatus) = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerCustomFormat* createCustomFormat() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyCustomFormat(IFMEServerCustomFormat*& customFormat) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerCustomFormatVector* createCustomFormatVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyCustomFormatVector(IFMEServerCustomFormatVector*& customFormatVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerCustomTransformer* createCustomTransformer() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyCustomTransformer(IFMEServerCustomTransformer*& customTransformer) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerCustomTransformerVector* createCustomTransformerVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyCustomTransformerVector(IFMEServerCustomTransformerVector*& customTransformerVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerResource* createResource() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyResource(IFMEServerResource*& resource) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerResourceVector* createResourceVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyResourceVector(IFMEServerResourceVector*& resourceVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerPropertyAccessor* createPropertyAccessor() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyPropertyAccessor(IFMEServerPropertyAccessor*& propertyAccessor) = 0;
   
   // -----------------------------------------------------------------------
   virtual IFMEServerConnectionInfo* createServerConnectionInfo(const IFMEServerString& url,
                                                                const IFMEServerString& userID,
                                                                const IFMEServerString& password) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerConnectionInfo* createServerConnectionInfo(const IFMEServerString& url,
                                                                const IFMEServerStringArray& directives) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerPropertyVector* createPropertyVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyPropertyVector(IFMEServerPropertyVector*& propertyVector) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerLogFileInfo* createLogFileInfo() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyLogFileInfo(IFMEServerLogFileInfo*& logFileInfo) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* getProperty(const IFMEServerString& propName, 
                                         IFMEServerString& propValue) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTemplate* createTemplate() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyTemplate(IFMEServerTemplate*& serverTemplate) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerTemplateVector* createTemplateVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyTemplateVector(IFMEServerTemplateVector*& templateVector) = 0;   

   // -----------------------------------------------------------------------
   virtual IFMEServerItemVector* createItemVector() = 0 ;

   // -----------------------------------------------------------------------
   virtual void destroyItemVector( IFMEServerItemVector*& itemVector ) = 0 ;

   // -----------------------------------------------------------------------
   virtual IFMEServerIdentity* getIdentity() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerSecurityManager* getSecurityManager() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerMountPointManager* getMountPointManager() = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerMountPoint* createMountPoint() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyMountPoint(IFMEServerMountPoint*& mountPoint) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerMountPointVector* createMountPointVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyMountPointVector(IFMEServerMountPointVector*& mountPoints) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerFileInfo* createFileInfo() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyFileInfo(IFMEServerFileInfo*& fileInfo) = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerFileInfoVector* createFileInfoVector() = 0;

   // -----------------------------------------------------------------------
   virtual void destroyFileInfoVector(IFMEServerFileInfoVector*& fileInfos) = 0;      

protected:

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

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

private:

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

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

#endif