Interface IntegrationInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Grant authenticate​(java.lang.String login, java.lang.String password, int endpoint)
      Authenticate
      void clear​(Grant g)
      Clear cache
      void clearCache​(Grant g, boolean logout, boolean notify, int preCompile)
      Clear cache
      void clearUserCache​(Grant g, java.lang.String login, boolean logout, boolean notify)
      Clear user cache
      Message commitModule​(Grant g, java.lang.String module, java.lang.String format, java.lang.String message)
      Git commit module
      Message deleteModule​(Grant g, java.lang.String module)
      Delete module
      Message exportModule​(Grant g, java.lang.String module, java.lang.String format, boolean zip, boolean timestamps, boolean inline)
      Export module as XML or ZIP (= XML + attached files)
      Message exportModuleData​(Grant g, java.lang.String module, java.lang.String format, boolean zip)
      Export module's data as XML or ZIP (= XML + attached files)
      Message exportObject​(Grant g, ObjectDB obj, java.lang.String id, boolean father, boolean children, java.util.Map<java.lang.String,​java.lang.String> h, FlowXML xml, int limit, boolean timestamps, boolean zip, boolean inline)
      Export object
      Message exportObject​(Grant g, java.lang.String object, boolean zip)
      Export object
      Message exportObject​(Grant g, java.lang.String object, boolean timestamps, boolean zip, boolean inline)
      Export object
      Message importADP​(Grant g, java.lang.String adp, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      Import through an adapter
      Message importCSV​(Grant g, java.lang.String obj, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      CSV import
      Message importJSON​(Grant g, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      JSON import
      Message importModule​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean zip, boolean diff)
      Import module
      Message importSAX​(com.simplicite.objects.System.XMLSupervisor xsp, java.lang.String xspId, java.io.InputStream in, java.lang.String docdir, Grant g, java.util.Map<java.lang.String,​java.lang.String> h)
      Import XML (using SAX parser) with supervision
      Message importSAX​(Grant g, java.io.InputStream in, java.lang.String docdir, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.String> h)
      Import XML (using SAX parser)
      Message importXML​(com.simplicite.objects.System.XMLSupervisor xsp, java.lang.String xspId, FlowXML in, Grant g, java.util.Map<java.lang.String,​java.lang.String> h)
      Import XML with supervision
      Message importXML​(Grant g, java.io.InputStream in, java.lang.String origin, java.lang.String parser, java.util.Map<java.lang.String,​java.lang.String> h)
      Import XML
      Message importYAML​(Grant g, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      YAML import
      Message importZIP​(Grant g, java.io.InputStream in, java.lang.String origin, java.lang.String parser, java.util.Map<java.lang.String,​java.lang.String> h)
      Import ZIP
      void indexation​(Grant g, boolean reset)
      Launch (re)indexation
      java.util.Map<java.lang.String,​java.lang.String> moduleContent​(Grant g, java.lang.String moduleId)
      Get module content
      void moduleDelete​(Grant g, java.util.Map<java.lang.String,​java.lang.String> map)
      Module delete
      Message process​(Grant g, java.lang.String service, java.io.InputStream in, java.util.Map<java.lang.String,​java.lang.Object> params, java.lang.String origin)
      Process
      void purgeExports​(Grant g)
      Purge export directory
      void purgeJobs​(Grant g)
      Purge asynchronous jobs
      void purgeLogs​(Grant g)
      Purge database logs
      void purgeRecycleBin​(Grant g)
      Purge recycle bin directory
      void purgeSupervisions​(Grant g)
      Purge import supervisions
      void purgeTempFiles​(Grant g)
      Purge temporary directory
      Message runSQLScript​(Grant g, java.lang.String datasource, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      Run SQL script
      java.lang.String runUnitTests​(Grant g, java.lang.String type, java.lang.String name)
      Run unit tests
      Message serviceManager​(Grant g, java.lang.String object, java.lang.String service, java.lang.Object[] params)
      Service manager
      Message serviceManager​(Grant g, java.lang.String obj, java.lang.String object, java.lang.String[] params)
      Service manager
      java.lang.String synchronizeDocs​(Grant g)
      (Re)synchronize documents
    • Method Detail

      • authenticate

        Grant authenticate​(java.lang.String login,
                           java.lang.String password,
                           int endpoint)
        Authenticate
        Parameters:
        login - Login
        password - Password
        endpoint - Endpoint
        Returns:
        Grant
      • clear

        void clear​(Grant g)
        Clear cache
        Parameters:
        g - Grant
      • clearCache

        void clearCache​(Grant g,
                        boolean logout,
                        boolean notify,
                        int preCompile)
        Clear cache
        Parameters:
        g - Grant
        logout - Logout?
        notify - Notify?
        preCompile - Pre compile?
      • clearUserCache

        void clearUserCache​(Grant g,
                            java.lang.String login,
                            boolean logout,
                            boolean notify)
        Clear user cache
        Parameters:
        g - Grant
        login - Login
        logout - Logout?
        notify - Notify?
      • process

        Message process​(Grant g,
                        java.lang.String service,
                        java.io.InputStream in,
                        java.util.Map<java.lang.String,​java.lang.Object> params,
                        java.lang.String origin)
        Process
        Parameters:
        g - Grant
        service - Service
        in - Input stream
        params - Parameters
        origin - Origin
        Returns:
        Message
      • importXML

        Message importXML​(Grant g,
                          java.io.InputStream in,
                          java.lang.String origin,
                          java.lang.String parser,
                          java.util.Map<java.lang.String,​java.lang.String> h)
        Import XML
        Parameters:
        g - Grant
        in - XML input stream
        origin - Origin
        parser - Parser
        h - Hash of imported objects
        Returns:
        Message
      • importZIP

        Message importZIP​(Grant g,
                          java.io.InputStream in,
                          java.lang.String origin,
                          java.lang.String parser,
                          java.util.Map<java.lang.String,​java.lang.String> h)
        Import ZIP
        Parameters:
        g - Grant
        in - ZIP input stream
        origin - Origin
        parser - Parser
        h - Hash of imported objects
        Returns:
        Message
      • importXML

        Message importXML​(com.simplicite.objects.System.XMLSupervisor xsp,
                          java.lang.String xspId,
                          FlowXML in,
                          Grant g,
                          java.util.Map<java.lang.String,​java.lang.String> h)
                   throws ImportException
        Import XML with supervision
        Parameters:
        xsp - Supervisoor
        xspId - Supervision ID
        in - XML flow
        g - Grant
        h - Hash of imported objects
        Returns:
        Message
        Throws:
        ImportException - In case of import exception
      • importSAX

        Message importSAX​(Grant g,
                          java.io.InputStream in,
                          java.lang.String docdir,
                          java.lang.String origin,
                          java.util.Map<java.lang.String,​java.lang.String> h)
        Import XML (using SAX parser)
        Parameters:
        g - Grant
        in - XML input stream
        docdir - Document directory
        origin - Origin
        h - Hash of imported objects
        Returns:
        Message
      • importSAX

        Message importSAX​(com.simplicite.objects.System.XMLSupervisor xsp,
                          java.lang.String xspId,
                          java.io.InputStream in,
                          java.lang.String docdir,
                          Grant g,
                          java.util.Map<java.lang.String,​java.lang.String> h)
                   throws ImportException
        Import XML (using SAX parser) with supervision
        Parameters:
        xsp - Supervisor
        xspId - Supervision ID
        in - XML input stream
        docdir - Docuemnt directory
        g - Grant
        h - Hash of imported objects
        Returns:
        Message
        Throws:
        ImportException - In cas of import exception
      • importADP

        Message importADP​(Grant g,
                          java.lang.String adp,
                          java.io.InputStream in,
                          java.lang.String origin,
                          java.util.Map<java.lang.String,​java.lang.Object> params)
        Import through an adapter
        Parameters:
        g - Grant
        adp - Adapter name
        in - Input stream
        origin - origin
        params - Parameters
        Returns:
        Message
      • importCSV

        Message importCSV​(Grant g,
                          java.lang.String obj,
                          java.io.InputStream in,
                          java.lang.String origin,
                          java.util.Map<java.lang.String,​java.lang.Object> params)
        CSV import
        Parameters:
        g - Grant
        obj - Object
        in - CSV input stream
        origin - Origin
        params - Parameters
        Returns:
        Message
      • importJSON

        Message importJSON​(Grant g,
                           java.io.InputStream in,
                           java.lang.String origin,
                           java.util.Map<java.lang.String,​java.lang.Object> params)
        JSON import
        Parameters:
        g - Grant
        in - JSON input stream
        origin - Origin
        params - Parameters
        Returns:
        Message
      • importYAML

        Message importYAML​(Grant g,
                           java.io.InputStream in,
                           java.lang.String origin,
                           java.util.Map<java.lang.String,​java.lang.Object> params)
        YAML import
        Parameters:
        g - Grant
        in - YAML input stream
        origin - Origin
        params - Parameters
        Returns:
        Message
      • runSQLScript

        Message runSQLScript​(Grant g,
                             java.lang.String datasource,
                             java.io.InputStream in,
                             java.lang.String origin,
                             java.util.Map<java.lang.String,​java.lang.Object> params)
        Run SQL script
        Parameters:
        g - Grant
        datasource - Datasrouce name
        in - SQL script input stream
        origin - Origin
        params - Parameters
        Returns:
        Message
      • exportObject

        Message exportObject​(Grant g,
                             ObjectDB obj,
                             java.lang.String id,
                             boolean father,
                             boolean children,
                             java.util.Map<java.lang.String,​java.lang.String> h,
                             FlowXML xml,
                             int limit,
                             boolean timestamps,
                             boolean zip,
                             boolean inline)
        Export object
        Parameters:
        g - Grant
        obj - Object
        id - Row ID
        father - Father object?
        children - Children objects?
        h - Parameters
        xml - XML flow
        limit - Limit
        timestamps - Timestamps?
        zip - ZIP?
        inline - Inline documents?
        Returns:
        Message
      • exportObject

        Message exportObject​(Grant g,
                             java.lang.String object,
                             boolean zip)
        Export object
        Parameters:
        g - Grant
        object - Object name
        zip - ZIP?
        Returns:
        Message
      • exportObject

        Message exportObject​(Grant g,
                             java.lang.String object,
                             boolean timestamps,
                             boolean zip,
                             boolean inline)
        Export object
        Parameters:
        g - Grant
        object - Object name
        timestamps - Timestamps?
        zip - ZIP?
        inline - Inline documents?
        Returns:
        Message
      • moduleContent

        java.util.Map<java.lang.String,​java.lang.String> moduleContent​(Grant g,
                                                                             java.lang.String moduleId)
        Get module content
        Parameters:
        g - Grant
        moduleId - Module ID
        Returns:
        Module content map
      • deleteModule

        Message deleteModule​(Grant g,
                             java.lang.String module)
        Delete module
        Parameters:
        g - Grant
        module - Module name
        Returns:
        Message
      • moduleDelete

        void moduleDelete​(Grant g,
                          java.util.Map<java.lang.String,​java.lang.String> map)
        Module delete
        Parameters:
        g - Grant
        map - Module content map
      • exportModule

        Message exportModule​(Grant g,
                             java.lang.String module,
                             java.lang.String format,
                             boolean zip,
                             boolean timestamps,
                             boolean inline)
        Export module as XML or ZIP (= XML + attached files)
        Parameters:
        g - Grant
        module - Module name
        format - Format (one of Integration.FORMAT_*)
        timestamps - Timestamps?
        inline - Inline documents?
        Returns:
        Message
      • exportModuleData

        Message exportModuleData​(Grant g,
                                 java.lang.String module,
                                 java.lang.String format,
                                 boolean zip)
        Export module's data as XML or ZIP (= XML + attached files)
        Parameters:
        g - Grant
        module - Module name
        format - Format (one of Integration.FORMAT_*)
        zip - ZIP?
        Returns:
        Message
      • importModule

        Message importModule​(Grant g,
                             java.lang.String module,
                             java.lang.String version,
                             java.io.InputStream in,
                             boolean zip,
                             boolean diff)
        Import module
        Parameters:
        g - Grant
        module - Module name
        version - Module version
        in - Module input stream
        zip - ZIP?
        diff - Apply diff?
        Returns:
        Message
      • commitModule

        Message commitModule​(Grant g,
                             java.lang.String module,
                             java.lang.String format,
                             java.lang.String message)
        Git commit module
        Parameters:
        g - Grant
        module - Module name
        format - Format (one of Integration.FORMAT_*)
        message - Commit message
        Returns:
        Message
      • indexation

        void indexation​(Grant g,
                        boolean reset)
        Launch (re)indexation
        Parameters:
        g - Grant
        reset - reste?
      • serviceManager

        Message serviceManager​(Grant g,
                               java.lang.String obj,
                               java.lang.String object,
                               java.lang.String[] params)
        Service manager
        Parameters:
        g - Grant
        obj - Object name
        object - Service name
        params - Service text parameters
        Returns:
        Message
      • serviceManager

        Message serviceManager​(Grant g,
                               java.lang.String object,
                               java.lang.String service,
                               java.lang.Object[] params)
        Service manager
        Parameters:
        g - Grant
        object - Object name
        service - Service name
        params - Service parameters
        Returns:
        Message
      • purgeLogs

        void purgeLogs​(Grant g)
        Purge database logs
        Parameters:
        g - Grant
      • purgeJobs

        void purgeJobs​(Grant g)
        Purge asynchronous jobs
        Parameters:
        g - Grant
      • purgeSupervisions

        void purgeSupervisions​(Grant g)
        Purge import supervisions
        Parameters:
        g - Grant
      • purgeRecycleBin

        void purgeRecycleBin​(Grant g)
        Purge recycle bin directory
        Parameters:
        g - Grant
      • purgeExports

        void purgeExports​(Grant g)
        Purge export directory
        Parameters:
        g - Grant
      • purgeTempFiles

        void purgeTempFiles​(Grant g)
        Purge temporary directory
        Parameters:
        g - Grant
      • synchronizeDocs

        java.lang.String synchronizeDocs​(Grant g)
        (Re)synchronize documents
        Parameters:
        g - Grant
        Returns:
        Synchronization result
      • runUnitTests

        java.lang.String runUnitTests​(Grant g,
                                      java.lang.String type,
                                      java.lang.String name)
        Run unit tests
        Parameters:
        g - Grant
        type - Type
        name - Name
        Returns:
        Unit test results