Class Integration


  • public class Integration
    extends java.lang.Object
    Integration
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Grant authenticate​(java.lang.String login, java.lang.String password, int endpoint)
      I/O user authentication
      void clear​(Grant g)
      Clear integration cache
      void clearCache​(Grant g, boolean logout, boolean notify, int preCompile)
      Clear global cache
      void clearUserCache​(Grant g)
      Deprecated.
      Use clearUserCache with additional arguments
      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 message)
      Module commit to Git with parameters GIT_FORMAT and EXPORT_MODULE_EXPLODED
      Message commitModule​(Grant g, java.lang.String module, java.lang.String message, java.lang.String format, boolean exploded)
      Module commit to Git
      Message deleteModule​(Grant g, java.lang.String module)
      Delete module
      Message exportModule​(Grant g, java.lang.String module, java.lang.String format, boolean archive, boolean exploded, boolean artifacts, boolean timestamps, boolean inline)
      Module export
      Message exportModuleData​(Grant g, java.lang.String module, java.lang.String format, boolean zip)
      Module data export
      Message exportModuleTree​(Grant g, java.lang.String module, boolean archive, boolean exploded, boolean artifacts)
      Module export as a JSON tree
      void exportModuleTreeDir​(Grant g, ObjectDB mdl, java.io.File dir, boolean exploded, boolean artifacts)
      Module export as a JSON tree dir
      Message exportObject​(Grant g, ObjectDB obj, java.lang.String id, boolean father, boolean child, java.util.Map<java.lang.String,​java.lang.String> h, FlowXML flow, boolean timestamps, boolean zip, boolean inline)
      Export one object in XML
      Message exportObject​(Grant g, ObjectDB obj, java.lang.String id, boolean father, boolean child, java.util.Map<java.lang.String,​java.lang.String> h, FlowXML flow, int limit, boolean timestamp, boolean zip, boolean inline)
      Export one object in XML
      Message exportObject​(Grant g, java.lang.String object, boolean zip)
      Export object to XML or ZIP flow
      Message exportObject​(Grant g, java.lang.String object, boolean timestamps, boolean zip, boolean inline)
      Export object to XML or ZIP flow
      static org.json.JSONArray getDatasetSpecs​(org.json.JSONObject spec)
      Get dataset import specifications from parsed import specification
      java.lang.String getLogs​(Grant g)
      Get logs
      static org.json.JSONArray getUnitTestsSpecs​(org.json.JSONObject spec)
      Get unit tests specifications from parsed import specification
      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 data flow thru 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)
      Import a CSV flow with parameters:
      - Parameter Integration.PARAM_OBJECT_NAME: target object name
      - Parameter Integration.PARAM_EXT_DOCDIR: External document root directory, field value contains the relative paths of documents to import (option)
      - Parameter Integration.PARAM_SEPARATOR: default value is ';' (option)
      - Parameter Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT
      Message importDatasetsFromSpecs​(Grant g, java.lang.String spec)
      Import datasets from import specifications (environment variable, files)
      Message importJSON​(Grant g, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      Import a JSON flow with parameters (Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT)
      Message importModule​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, java.lang.String format, boolean zip, boolean diff)
      Deprecated.
      Use importModule with stopOnError argument
      Message importModule​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, java.lang.String format, java.lang.String zipFormat, boolean diff, boolean stopOnError, boolean async)
      Import module
      Message importModuleJSON​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff)
      Deprecated.
      Use importModuleJSON with stopOnError argument
      Message importModuleJSON​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff, boolean stopOnError, boolean async)
      Import module from a single JSON file
      Message importModulesFromSpecs​(Grant g, java.lang.String spec)
      Import business modules from import specifications (environment variable, files)
      Message importModuleXML​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff)
      Deprecated.
      Use importModuleXML with stopOnError argument
      Message importModuleXML​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff, boolean stopOnError, boolean async)
      Import module from a single XML file
      Message importModuleYAML​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      Message importModuleYAML​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff, boolean stopOnError, boolean async)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      Message importModuleZIP​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff)
      Deprecated.
      Use importModuleZIP with stopOnError argument
      Message importModuleZIP​(Grant g, java.lang.String module, java.lang.String version, java.io.InputStream in, boolean diff, boolean stopOnError, boolean async, java.lang.String zipFormat)
      Import module from a ZIP archive
      Message importSAX​(com.simplicite.objects.System.XMLSupervisor xsp, java.lang.String xspId, java.io.InputStream in, java.lang.String docdir, boolean stopOnError, boolean async, Grant g, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a XML flow within a SAX parser (to limit heap size)
      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)
      Deprecated. 
      Message importSAX​(Grant g, java.io.InputStream in, java.lang.String docdir, boolean stopOnError, boolean async, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a XML flow within a SAX parser (to limit heap size)
      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)
      Deprecated. 
      Message importXML​(com.simplicite.objects.System.XMLSupervisor xsp, java.lang.String xspId, FlowXML in, boolean stopOnError, Grant g, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a XML flow with optional supervisor (in memory processing)
      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)
      Deprecated. 
      Message importXML​(Grant g, java.io.InputStream in, java.lang.String origin, boolean stopOnError, boolean async, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a XML flow
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use importXML with stopOnError argument
      Message importXML​(Grant g, java.lang.String data, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.String> h)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use importXML wit input stream argument
      Message importYAML​(Grant g, java.io.InputStream in, java.lang.String origin, java.util.Map<java.lang.String,​java.lang.Object> params)
      Import a YAML flow with parameters (Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT)
      Message importZIP​(Grant g, java.io.InputStream in, java.lang.String origin, boolean stopOnError, boolean async, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a ZIP file
      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)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      Message importZIP​(Grant g, java.lang.String path, java.lang.String origin, boolean stopOnError, boolean async, java.util.Map<java.lang.String,​java.lang.String> h)
      Import a ZIP file
      Message importZIP​(Grant g, java.lang.String path, java.lang.String origin, java.lang.String parser, java.util.Map<java.lang.String,​java.lang.String> h)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      Message indexation​(Grant g)
      (Re)build indexation
      java.util.Map<java.lang.String,​java.lang.String> moduleContent​(Grant g, java.lang.String moduleId)
      Parse the module contents
      void moduleDelete​(Grant g, java.util.Map<java.lang.String,​java.lang.String> h)
      Remove obsolete objects
      static org.json.JSONObject parseAllImportSpecs​(java.lang.String spec)
      Parse import specification(s) into a consolidated JSON object
      void postImportModule​(Grant g, java.lang.String moduleId, boolean compile, boolean rebuildDBIndexes, boolean rebuildDataIndexes, boolean async)
      Post import of module
      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 a service
      Message process​(Grant g, java.lang.String service, java.lang.String data, java.util.Map<java.lang.String,​java.lang.Object> params, java.lang.String origin)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use process with input stream argument
      Message purgeExports​(Grant g)
      Purge exports
      Message purgeJobs​(Grant g, int depth)
      Purge jobs
      Message purgeLogs​(Grant g, int depth)
      Purge logs
      Message purgeRecycleBin​(Grant g)
      Purge recycle bin
      Message purgeSupervisions​(Grant g, int depth)
      Purge supervisions
      Message purgeTempFiles​(Grant g)
      Purge temp files
      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 a SQL script with parameters (Integration.PARAM_DATSOURCE_NAME: datasource name)
      java.lang.String runUnitTests​(Grant g, java.lang.String type, java.lang.String name)
      Run unit tests
      Message runUnitTestsFromSpecs​(Grant g, java.lang.String spec)
      Run unit tests from import specifications (environment variable, files)
      Message serviceManager​(Grant g, java.lang.String object, java.lang.String service, java.lang.Object[] params)
      Invoke one object's service with any type parameters
      Message serviceManager​(Grant g, java.lang.String object, java.lang.String service, java.lang.String[] params)
      Invoke one object's service with text parameters
      java.lang.String synchronizeDocs​(Grant g)
      Synchronize documents
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • BUSINESS_SERVICE

        public static final java.lang.String BUSINESS_SERVICE
        Invoke a service (action on business object)
        See Also:
        Constant Field Values
      • BUSINESS_QUERY

        public static final java.lang.String BUSINESS_QUERY
        Invoke a bussiness object search
        See Also:
        Constant Field Values
      • FORMAT_XML

        public static final java.lang.String FORMAT_XML
        XML format
      • FORMAT_CSV

        public static final java.lang.String FORMAT_CSV
        CSV format
      • FORMAT_JSON

        public static final java.lang.String FORMAT_JSON
        JSON format
      • FORMAT_YAML

        public static final java.lang.String FORMAT_YAML
        YAML format
      • FORMAT_ZIP

        public static final java.lang.String FORMAT_ZIP
        ZIP format
      • FORMAT_GZIP

        public static final java.lang.String FORMAT_GZIP
        GZIP format
      • BUSINESS_IMPORT_XML

        public static final java.lang.String BUSINESS_IMPORT_XML
        Import a Simplicite XML flow
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_CSV

        public static final java.lang.String BUSINESS_IMPORT_CSV
        Import a Simplicite CSV flow
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_JSON

        public static final java.lang.String BUSINESS_IMPORT_JSON
        Import a Simplicite JSON flow
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_YAML

        public static final java.lang.String BUSINESS_IMPORT_YAML
        Import a Simplicite YAML flow
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_ADP

        public static final java.lang.String BUSINESS_IMPORT_ADP
        Import a flow with one adaptor
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_ZIP

        public static final java.lang.String BUSINESS_IMPORT_ZIP
        Import a ZIP flow
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_MODULE

        public static final java.lang.String BUSINESS_IMPORT_MODULE
        Import a Simplicite module
        See Also:
        Constant Field Values
      • BUSINESS_IMPORT_MODULES

        public static final java.lang.String BUSINESS_IMPORT_MODULES
        Import several Simplicite modules from an import specification
        See Also:
        Constant Field Values
      • BUSINESS_SQLSCRIPT

        public static final java.lang.String BUSINESS_SQLSCRIPT
        Run a SQL script flow
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_XML

        public static final java.lang.String BUSINESS_EXPORT_XML
        Export a XML flow
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_CSV

        public static final java.lang.String BUSINESS_EXPORT_CSV
        Export a CSV flow
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_JSON

        public static final java.lang.String BUSINESS_EXPORT_JSON
        Export a JSON flow
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_YAML

        public static final java.lang.String BUSINESS_EXPORT_YAML
        Export a YAML flow
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_ZIP

        public static final java.lang.String BUSINESS_EXPORT_ZIP
        Export a ZIP flow including XML and documents
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_MODULE

        public static final java.lang.String BUSINESS_EXPORT_MODULE
        Export a module
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_MODULE_TREE

        public static final java.lang.String BUSINESS_EXPORT_MODULE_TREE
        Export a module tree
        See Also:
        Constant Field Values
      • BUSINESS_EXPORT_MODULE_DATA

        public static final java.lang.String BUSINESS_EXPORT_MODULE_DATA
        Export a module's data
        See Also:
        Constant Field Values
      • BUSINESS_COMMIT_MODULE

        public static final java.lang.String BUSINESS_COMMIT_MODULE
        Commit a Simplicite module to Git
        See Also:
        Constant Field Values
      • CSV_ADAPTER_NAME

        public static final java.lang.String CSV_ADAPTER_NAME
        Standard CSV adapter name
        See Also:
        Constant Field Values
      • JSON_ADAPTER_NAME

        public static final java.lang.String JSON_ADAPTER_NAME
        Standard JSON adapter name
        See Also:
        Constant Field Values
      • YAML_ADAPTER_NAME

        public static final java.lang.String YAML_ADAPTER_NAME
        Standard YAML adapter name
        See Also:
        Constant Field Values
      • SQLSCRIPT_ADAPTER_NAME

        public static final java.lang.String SQLSCRIPT_ADAPTER_NAME
        Standard SQL adapter name
        See Also:
        Constant Field Values
      • BUSINESS_DELETE_MODULE

        public static final java.lang.String BUSINESS_DELETE_MODULE
        Delete a Simplicite module
        See Also:
        Constant Field Values
      • BUILD_INDEX

        public static final java.lang.String BUILD_INDEX
        Rebuild index
        See Also:
        Constant Field Values
      • CLEAR_CACHE

        public static final java.lang.String CLEAR_CACHE
        Clear integration cache
        See Also:
        Constant Field Values
      • RESTART_CRON

        public static final java.lang.String RESTART_CRON
        Restart cron
        See Also:
        Constant Field Values
      • COUNT_SESSIONS

        public static final java.lang.String COUNT_SESSIONS
        Count sessions
        See Also:
        Constant Field Values
      • PURGE_JOBS

        public static final java.lang.String PURGE_JOBS
        Purge asynchronous jobs
        See Also:
        Constant Field Values
      • PURGE_SUPERVISIONS

        public static final java.lang.String PURGE_SUPERVISIONS
        Purge supervisions
        See Also:
        Constant Field Values
      • PURGE_RECYCLEBIN

        public static final java.lang.String PURGE_RECYCLEBIN
        Purge recycle bin
        See Also:
        Constant Field Values
      • PURGE_EXPORTS

        public static final java.lang.String PURGE_EXPORTS
        Purge exports
        See Also:
        Constant Field Values
      • PURGE_TEMPFILES

        public static final java.lang.String PURGE_TEMPFILES
        Purge temp files
        See Also:
        Constant Field Values
      • SYNC_DOCS

        public static final java.lang.String SYNC_DOCS
        Synchronize documents
        See Also:
        Constant Field Values
      • ACTION_INSERT

        public static final java.lang.String ACTION_INSERT
        Create if not exists
        See Also:
        Constant Field Values
      • ACTION_UPSERT

        public static final java.lang.String ACTION_UPSERT
        Update or create if not exists
        See Also:
        Constant Field Values
      • ACTION_UPDATE

        public static final java.lang.String ACTION_UPDATE
        Update if exists
        See Also:
        Constant Field Values
      • ACTION_DELETE

        public static final java.lang.String ACTION_DELETE
        Delete
        See Also:
        Constant Field Values
      • PARAM_OBJECT_NAME

        public static final java.lang.String PARAM_OBJECT_NAME
        Parameter Object name
        See Also:
        Constant Field Values
      • PARAM_ADAPTER_NAME

        public static final java.lang.String PARAM_ADAPTER_NAME
        Parameter Adapter name
        See Also:
        Constant Field Values
      • PARAM_ADAPTER_MODE

        public static final java.lang.String PARAM_ADAPTER_MODE
        Parameter adapter mode DIRECT or INDIRECT
        See Also:
        Constant Field Values
      • PARAM_ENCODING

        public static final java.lang.String PARAM_ENCODING
        Parameter encoding
        See Also:
        Constant Field Values
      • PARAM_EFFECTIVE_DATE

        public static final java.lang.String PARAM_EFFECTIVE_DATE
        Parameter Effective date
        See Also:
        Constant Field Values
      • PARAM_CLEAR_CACHE

        public static final java.lang.String PARAM_CLEAR_CACHE
        Parameter Clear cache
        See Also:
        Constant Field Values
      • PARAM_EXT_DOCDIR

        public static final java.lang.String PARAM_EXT_DOCDIR
        Parameter External doc directory
        See Also:
        Constant Field Values
      • PARAM_DATASOURCE_NAME

        public static final java.lang.String PARAM_DATASOURCE_NAME
        Parameter Datsource name
        See Also:
        Constant Field Values
      • PARAM_SEPARATOR

        public static final java.lang.String PARAM_SEPARATOR
        CSV Parameter file separator
        See Also:
        Constant Field Values
      • PARAM_QUOTE

        public static final java.lang.String PARAM_QUOTE
        CSV Parameter quote character
        See Also:
        Constant Field Values
      • PARAM_NEW_LINE

        public static final java.lang.String PARAM_NEW_LINE
        CSV Parameter line return symbols
        See Also:
        Constant Field Values
      • PARAM_COMMENT_SYMBOL

        public static final java.lang.String PARAM_COMMENT_SYMBOL
        CSV Parameter commented line
        See Also:
        Constant Field Values
      • PARAM_MAPPINGS

        public static final java.lang.String PARAM_MAPPINGS
        CSV Parameter fields mapping
        See Also:
        Constant Field Values
      • PARAM_HEADER

        public static final java.lang.String PARAM_HEADER
        CSV Parameter has header
        See Also:
        Constant Field Values
      • XML_PARSER_DOM

        @Deprecated(forRemoval=true,
                    since="5")
        public static final java.lang.String XML_PARSER_DOM
        Deprecated, for removal: This API element is subject to removal in a future version.
        Not used anymore
        See Also:
        Constant Field Values
      • XML_PARSER_SAX

        @Deprecated(forRemoval=true,
                    since="5")
        public static final java.lang.String XML_PARSER_SAX
        Deprecated, for removal: This API element is subject to removal in a future version.
        See Also:
        Constant Field Values
      • RESULT_XML

        public static final java.lang.String RESULT_XML
        FlowXML result
        See Also:
        Constant Field Values
      • RESULT_ZIP

        public static final java.lang.String RESULT_ZIP
        ZIP Bytes result
        See Also:
        Constant Field Values
      • RESULT_FILE

        public static final java.lang.String RESULT_FILE
        File path result
        See Also:
        Constant Field Values
      • RESULT_XSP_ID

        public static final java.lang.String RESULT_XSP_ID
        XML supervisor id
        See Also:
        Constant Field Values
      • EXPORTPATH_CONFIGURATION

        public static final java.lang.String EXPORTPATH_CONFIGURATION
        Configuration base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_SOURCES

        public static final java.lang.String EXPORTPATH_SOURCES
        Java sources base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_SCRIPTS

        public static final java.lang.String EXPORTPATH_SCRIPTS
        Scripted sources base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_RESOURCES

        public static final java.lang.String EXPORTPATH_RESOURCES
        Resources base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_TESTS

        public static final java.lang.String EXPORTPATH_TESTS
        Tests base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_LIBS

        public static final java.lang.String EXPORTPATH_LIBS
        Libraries base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_FILES

        public static final java.lang.String EXPORTPATH_FILES
        Files base export path
        See Also:
        Constant Field Values
      • EXPORTPATH_DATASETS

        public static final java.lang.String EXPORTPATH_DATASETS
        Datasets base export path
        See Also:
        Constant Field Values
      • MODULES_IMPORT_SPEC_DIRNAME

        public static final java.lang.String MODULES_IMPORT_SPEC_DIRNAME
        Modules import spec local directory name
        See Also:
        Constant Field Values
      • MODULES_IMPORT_SPEC_ENVNAME

        public static final java.lang.String MODULES_IMPORT_SPEC_ENVNAME
        Modules import spec environment variable name
        See Also:
        Constant Field Values
    • Constructor Detail

      • Integration

        public Integration()
    • Method Detail

      • authenticate

        public Grant authenticate​(java.lang.String login,
                                  java.lang.String password,
                                  int endpoint)
        I/O user authentication
        Parameters:
        login - I/O user login
        password - I/O user password
        endpoint - End point (one of Globals.ENDPOINT_*)
        Returns:
        Grant
      • clear

        public void clear​(Grant g)
        Clear integration cache
      • clearCache

        public void clearCache​(Grant g,
                               boolean logout,
                               boolean notify,
                               int preCompile)
        Clear global cache
        Parameters:
        g - Admin rights
        logout - Invalidate all sessions ?
        notify - Notify all servers ?
        preCompile - pre-compile objects and processes? One of Globals.PRECOMPILE_*
      • clearUserCache

        @Deprecated(forRemoval=false,
                    since="5")
        public final void clearUserCache​(Grant g)
        Deprecated.
        Use clearUserCache with additional arguments
      • clearUserCache

        public void clearUserCache​(Grant g,
                                   java.lang.String login,
                                   boolean logout,
                                   boolean notify)
        Clear user cache
        Parameters:
        g - Admin rights
        login - User login
        logout - Invalidate all user's sessions ?
        notify - Notify all servers ?
      • process

        @Deprecated(forRemoval=true,
                    since="4.0")
        public Message process​(Grant g,
                               java.lang.String service,
                               java.lang.String data,
                               java.util.Map<java.lang.String,​java.lang.Object> params,
                               java.lang.String origin)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use process with input stream argument
      • process

        public 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 a service
      • importXML

        @Deprecated(forRemoval=true,
                    since="4.0")
        public Message importXML​(Grant g,
                                 java.lang.String data,
                                 java.lang.String origin,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use importXML wit input stream argument
      • importXML

        @Deprecated(forRemoval=true,
                    since="5")
        public 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)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use importXML with stopOnError argument
      • importXML

        public Message importXML​(Grant g,
                                 java.io.InputStream in,
                                 java.lang.String origin,
                                 boolean stopOnError,
                                 boolean async,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Import a XML flow
        Parameters:
        g - Grant
        in - XML message to load in memory
        origin - Flow origin
        stopOnError - Stop import when an error is detected
        async - Parallel loading
        h - Optional colored hash of imported objects
        Returns:
        Message with LOG + h + supervision Id
      • importXML

        @Deprecated(forRemoval=false,
                    since="5")
        public 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
        Deprecated.
        Throws:
        ImportException
      • importXML

        public Message importXML​(com.simplicite.objects.System.XMLSupervisor xsp,
                                 java.lang.String xspId,
                                 FlowXML in,
                                 boolean stopOnError,
                                 Grant g,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
                          throws ImportException
        Import a XML flow with optional supervisor (in memory processing)
        Parameters:
        xsp - Optional supervisor
        xspId - Supervision Id
        in - In memory XML flow
        stopOnError - Stop import when an error is detected
        g - User rights
        h - Optional colored hash of imported objects
        Returns:
        Message with results
        Throws:
        ImportException
      • importSAX

        @Deprecated(forRemoval=false,
                    since="5")
        public 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)
                          throws ImportException
        Deprecated.
        Throws:
        ImportException
      • importSAX

        public Message importSAX​(Grant g,
                                 java.io.InputStream in,
                                 java.lang.String docdir,
                                 boolean stopOnError,
                                 boolean async,
                                 java.lang.String origin,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
                          throws ImportException
        Import a XML flow within a SAX parser (to limit heap size)
        Parameters:
        g - User rights
        in - XML flow
        docdir - Optional doc directory
        stopOnError - Stop import when an error is detected
        async - Parallel loading of data
        origin - Sender
        h - Optional colored hash of imported objects
        Returns:
        Message with results
        Throws:
        ImportException
      • importSAX

        @Deprecated(forRemoval=false,
                    since="5")
        public 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
        Deprecated.
        Throws:
        ImportException
      • importSAX

        public Message importSAX​(com.simplicite.objects.System.XMLSupervisor xsp,
                                 java.lang.String xspId,
                                 java.io.InputStream in,
                                 java.lang.String docdir,
                                 boolean stopOnError,
                                 boolean async,
                                 Grant g,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
                          throws ImportException
        Import a XML flow within a SAX parser (to limit heap size)
        Parameters:
        xsp - Optional supervisor
        xspId - Supervision Id
        in - XML flow
        docdir - Optional doc directory
        stopOnError - Stop import when an error is detected
        async - Parallel loading of data
        g - User rights
        h - Optional colored hash of imported objects
        Returns:
        Message with results
        Throws:
        ImportException
      • importADP

        public 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 data flow thru an adapter
        Parameters:
        g - Grant
        adp - Adapter name
        in - Data input stream
        origin - Origin
        params - Optional parameters
        Returns:
        Message
      • importZIP

        @Deprecated(forRemoval=true,
                    since="5")
        public 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)
        Deprecated, for removal: This API element is subject to removal in a future version.
      • importZIP

        public Message importZIP​(Grant g,
                                 java.io.InputStream in,
                                 java.lang.String origin,
                                 boolean stopOnError,
                                 boolean async,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Import a ZIP file
        Parameters:
        g - Grant
        in - ZIP data input stream
        origin - Sender origin
        stopOnError - Stop import when an error is detected
        async - Parallel loading of data
        h - Colored hash
        Returns:
        Message with LOG + h + xsp_id
      • importZIP

        @Deprecated(forRemoval=true,
                    since="5")
        public Message importZIP​(Grant g,
                                 java.lang.String path,
                                 java.lang.String origin,
                                 java.lang.String parser,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Deprecated, for removal: This API element is subject to removal in a future version.
      • importZIP

        public Message importZIP​(Grant g,
                                 java.lang.String path,
                                 java.lang.String origin,
                                 boolean stopOnError,
                                 boolean async,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Import a ZIP file
        Parameters:
        g - Grant
        path - Path to ZIP file
        origin - Sender origin
        stopOnError - Stop import when an error is detected
        async - Parallel loading of data
        h - Colored hash
        Returns:
        Message with LOG + h + xsp_id
      • importCSV

        public 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)
        Import a CSV flow with parameters:
        - Parameter Integration.PARAM_OBJECT_NAME: target object name
        - Parameter Integration.PARAM_EXT_DOCDIR: External document root directory, field value contains the relative paths of documents to import (option)
        - Parameter Integration.PARAM_SEPARATOR: default value is ';' (option)
        - Parameter Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT
        Parameters:
        g - User rights
        obj - Object name
        in - CSV stream ZZZ in platform encoding ZZZ
        origin - Sender origin
        params - Hash of parameters
        Returns:
        Message
      • importJSON

        public Message importJSON​(Grant g,
                                  java.io.InputStream in,
                                  java.lang.String origin,
                                  java.util.Map<java.lang.String,​java.lang.Object> params)
        Import a JSON flow with parameters (Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT)
        Parameters:
        g - Grant
        in - JSON input stream
        origin - Sender
        params - Hash of parameters
        Returns:
        Message
      • importYAML

        public Message importYAML​(Grant g,
                                  java.io.InputStream in,
                                  java.lang.String origin,
                                  java.util.Map<java.lang.String,​java.lang.Object> params)
        Import a YAML flow with parameters (Integration.PARAM_ADAPTER_MODE: INDIRECT|DIRECT, build one XML file or not, default is INDIRECT)
        Parameters:
        g - Grant
        in - YAML input stream
        origin - Sender
        params - Hash of parameters
        Returns:
        Message
      • runSQLScript

        public 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 a SQL script with parameters (Integration.PARAM_DATSOURCE_NAME: datasource name)
        Parameters:
        g - Grant
        in - SQL script input stream
        origin - Sender
        params - Hash of parameters
        Returns:
        Message
      • exportObject

        public Message exportObject​(Grant g,
                                    ObjectDB obj,
                                    java.lang.String id,
                                    boolean father,
                                    boolean child,
                                    java.util.Map<java.lang.String,​java.lang.String> h,
                                    FlowXML flow,
                                    int limit,
                                    boolean timestamp,
                                    boolean zip,
                                    boolean inline)
                             throws java.io.IOException
        Export one object in XML
        Parameters:
        g - Grant
        obj - Business object
        id - Record row_id
        father - True to retrieve fathers
        child - True to retrieve children
        h - Colored hash (to check export unicity)
        flow - Optional to add object to a former flow
        limit - Limit the number of objects (0=no limit)
        timestamp - Export timestamps?
        zip - ZIP export?
        inline - Inline documents/images in XML
        Returns:
        XML flow
        Throws:
        java.io.IOException
      • exportObject

        public Message exportObject​(Grant g,
                                    ObjectDB obj,
                                    java.lang.String id,
                                    boolean father,
                                    boolean child,
                                    java.util.Map<java.lang.String,​java.lang.String> h,
                                    FlowXML flow,
                                    boolean timestamps,
                                    boolean zip,
                                    boolean inline)
                             throws java.io.IOException
        Export one object in XML
        Parameters:
        g - Grant
        obj - Business object
        id - Record row_id
        father - True to retrieve fathers
        child - True to retrieve children
        h - Colored hash (to check export unicity)
        flow - Optional to add object to an former flow
        timestamps - Export timestamps?
        zip - ZIP export with memory usage? (use FlowXML with output stream to avoid heap overflow)
        inline - Inline documents/images in XML
        Returns:
        XML flow
        Throws:
        java.io.IOException
      • exportObject

        public Message exportObject​(Grant g,
                                    java.lang.String object,
                                    boolean zip)
                             throws java.io.IOException
        Export object to XML or ZIP flow
        Parameters:
        g - Grant
        object - Object name
        zip - ZIP export ?
        Throws:
        java.io.IOException
      • exportObject

        public Message exportObject​(Grant g,
                                    java.lang.String object,
                                    boolean timestamps,
                                    boolean zip,
                                    boolean inline)
                             throws java.io.IOException
        Export object to XML or ZIP flow
        Parameters:
        g - Grant
        object - Object name
        timestamps - Export timestamps?
        zip - ZIP export ?
        inline - Inline documents/images in XML
        Throws:
        java.io.IOException
      • moduleContent

        public java.util.Map<java.lang.String,​java.lang.String> moduleContent​(Grant g,
                                                                                    java.lang.String moduleId)
        Parse the module contents
        Parameters:
        g - Grant
        moduleId - Module ID
        Returns:
        Hash for coloration (key table:row_id)
      • deleteModule

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

        public void moduleDelete​(Grant g,
                                 java.util.Map<java.lang.String,​java.lang.String> h)
        Remove obsolete objects
        Parameters:
        g - Grant
      • exportModule

        public Message exportModule​(Grant g,
                                    java.lang.String module,
                                    java.lang.String format,
                                    boolean archive,
                                    boolean exploded,
                                    boolean artifacts,
                                    boolean timestamps,
                                    boolean inline)
        Module export
        Parameters:
        g - Grant
        module - Module name
        format - Format
        archive - Archive (ZIP)?
        exploded - Exploded? Only applicable if archive is true
        artifacts - With artifacts? Only applicable if archive is true
        timestamps - Timestamps?
        inline - Inline documents?
        Returns:
        Message
      • exportModuleTreeDir

        public void exportModuleTreeDir​(Grant g,
                                        ObjectDB mdl,
                                        java.io.File dir,
                                        boolean exploded,
                                        boolean artifacts)
        Module export as a JSON tree dir
        Parameters:
        g - Grant
        mdl - Module object
        dir - Export dir
        exploded - Exploded?
        artifacts - With artifacts?
      • exportModuleTree

        public Message exportModuleTree​(Grant g,
                                        java.lang.String module,
                                        boolean archive,
                                        boolean exploded,
                                        boolean artifacts)
        Module export as a JSON tree
        Parameters:
        g - Grant
        module - Module name
        archive - Archive (TAR.GZ)?
        exploded - Exploded? Only applicable if archive is true
        artifacts - With artifacts? Only applicable if archive is true
        Returns:
        Message
      • exportModuleData

        public Message exportModuleData​(Grant g,
                                        java.lang.String module,
                                        java.lang.String format,
                                        boolean zip)
        Module data export
        Parameters:
        g - Grant
        module - Module name
        format - Format
        zip - ZIP?
        Returns:
        Message
      • importModuleXML

        @Deprecated(forRemoval=false,
                    since="5")
        public Message importModuleXML​(Grant g,
                                       java.lang.String module,
                                       java.lang.String version,
                                       java.io.InputStream in,
                                       boolean diff)
        Deprecated.
        Use importModuleXML with stopOnError argument
      • importModuleXML

        public Message importModuleXML​(Grant g,
                                       java.lang.String module,
                                       java.lang.String version,
                                       java.io.InputStream in,
                                       boolean diff,
                                       boolean stopOnError,
                                       boolean async)
        Import module from a single XML file
        Parameters:
        g - Grant
        module - Module name
        version - Module version
        in - Module input stream
        diff - Apply diff?
        stopOnError - Stop import when error is detected
        async - Parallel loading of data
        Returns:
        Message
      • parseAllImportSpecs

        public static org.json.JSONObject parseAllImportSpecs​(java.lang.String spec)
                                                       throws org.json.JSONException
        Parse import specification(s) into a consolidated JSON object
        Parameters:
        spec - Optional specification string as JSON or YAML (if null all other types of import specifications are retreived)
        Returns:
        Consolidated import specifications
        Throws:
        org.json.JSONException
      • importModulesFromSpecs

        public Message importModulesFromSpecs​(Grant g,
                                              java.lang.String spec)
        Import business modules from import specifications (environment variable, files)
        Parameters:
        g - Grant
        spec - Explicit import specification, if null the default import specifications are used = the MODULES_IMPORT_SPEC environment variable and the import specification files located in the modules import directory
        Returns:
        Message
      • getDatasetSpecs

        public static org.json.JSONArray getDatasetSpecs​(org.json.JSONObject spec)
                                                  throws org.json.JSONException
        Get dataset import specifications from parsed import specification
        Parameters:
        spec - Parsed import specification
        Returns:
        Array of dataset import specifications
        Throws:
        org.json.JSONException
      • importDatasetsFromSpecs

        public Message importDatasetsFromSpecs​(Grant g,
                                               java.lang.String spec)
        Import datasets from import specifications (environment variable, files)
        Parameters:
        g - Grant
        spec - Import specification, if null the default import specifications are used = the MODULES_IMPORT_SPEC environment variable and the import specification files located in the modules import directory
        Returns:
        Message
      • getUnitTestsSpecs

        public static org.json.JSONArray getUnitTestsSpecs​(org.json.JSONObject spec)
                                                    throws org.json.JSONException
        Get unit tests specifications from parsed import specification
        Parameters:
        spec - Parsed import specification
        Returns:
        Array of unit tests specifications
        Throws:
        org.json.JSONException
      • runUnitTestsFromSpecs

        public Message runUnitTestsFromSpecs​(Grant g,
                                             java.lang.String spec)
        Run unit tests from import specifications (environment variable, files)
        Parameters:
        g - Grant
        spec - Import specification, if null the default import specifications are used = the MODULES_IMPORT_SPEC environment variable and the import specification files located in the modules import directory
        Returns:
        Message
      • importModuleJSON

        @Deprecated(forRemoval=false,
                    since="5")
        public Message importModuleJSON​(Grant g,
                                        java.lang.String module,
                                        java.lang.String version,
                                        java.io.InputStream in,
                                        boolean diff)
        Deprecated.
        Use importModuleJSON with stopOnError argument
      • importModuleJSON

        public Message importModuleJSON​(Grant g,
                                        java.lang.String module,
                                        java.lang.String version,
                                        java.io.InputStream in,
                                        boolean diff,
                                        boolean stopOnError,
                                        boolean async)
        Import module from a single JSON file
        Parameters:
        g - Grant
        module - Module name
        version - Module version
        in - Module input stream
        diff - Apply diff?
        stopOnError - Stop import when error is detected
        async - Parallel loading of data
        Returns:
        Message
      • importModuleYAML

        @Deprecated(forRemoval=true,
                    since="5")
        public Message importModuleYAML​(Grant g,
                                        java.lang.String module,
                                        java.lang.String version,
                                        java.io.InputStream in,
                                        boolean diff)
        Deprecated, for removal: This API element is subject to removal in a future version.
      • importModuleYAML

        @Deprecated(forRemoval=true,
                    since="5")
        public Message importModuleYAML​(Grant g,
                                        java.lang.String module,
                                        java.lang.String version,
                                        java.io.InputStream in,
                                        boolean diff,
                                        boolean stopOnError,
                                        boolean async)
        Deprecated, for removal: This API element is subject to removal in a future version.
      • importModuleZIP

        @Deprecated(forRemoval=false,
                    since="5")
        public Message importModuleZIP​(Grant g,
                                       java.lang.String module,
                                       java.lang.String version,
                                       java.io.InputStream in,
                                       boolean diff)
        Deprecated.
        Use importModuleZIP with stopOnError argument
      • importModuleZIP

        public Message importModuleZIP​(Grant g,
                                       java.lang.String module,
                                       java.lang.String version,
                                       java.io.InputStream in,
                                       boolean diff,
                                       boolean stopOnError,
                                       boolean async,
                                       java.lang.String zipFormat)
        Import module from a ZIP archive
        Parameters:
        g - Grant
        module - Module name
        version - Module version
        in - Module input stream
        diff - Apply diff?
        stopOnError - Stop import when error is detected
        async - Parallel loading of data
        zipFormat - Integration.FORMAT_ZIP or Integration.FORMAT_GZIP
        Returns:
        Message
      • importModule

        @Deprecated(forRemoval=false,
                    since="5")
        public Message importModule​(Grant g,
                                    java.lang.String module,
                                    java.lang.String version,
                                    java.io.InputStream in,
                                    java.lang.String format,
                                    boolean zip,
                                    boolean diff)
        Deprecated.
        Use importModule with stopOnError argument
      • importModule

        public Message importModule​(Grant g,
                                    java.lang.String module,
                                    java.lang.String version,
                                    java.io.InputStream in,
                                    java.lang.String format,
                                    java.lang.String zipFormat,
                                    boolean diff,
                                    boolean stopOnError,
                                    boolean async)
        Import module
        Parameters:
        g - Grant
        module - Module name
        version - Module version
        in - Module input stream
        format - Format (one of Integration.FORMAT_*)
        zipFormat - Integration.FORMAT_ZIP or Integration.FORMAT_GZIP
        diff - Apply diff?
        stopOnError - Stop import when error is detected
        async - Parallel loading of data
        Returns:
        Message
      • postImportModule

        public void postImportModule​(Grant g,
                                     java.lang.String moduleId,
                                     boolean compile,
                                     boolean rebuildDBIndexes,
                                     boolean rebuildDataIndexes,
                                     boolean async)
        Post import of module
        Parameters:
        g - Grant
        moduleId - Module Id
        compile - Compile all business classes?
        rebuildDBIndexes - True to rebuild DB INDEX, false to only generate the SQL script
        rebuildDataIndexes - Rebuild full-text indexes?
        async - Rebuild asynchronously?
      • commitModule

        public Message commitModule​(Grant g,
                                    java.lang.String module,
                                    java.lang.String message)
        Module commit to Git with parameters GIT_FORMAT and EXPORT_MODULE_EXPLODED
        Parameters:
        g - Grant
        module - Module name
        message - Commit message
        Returns:
        Message
      • commitModule

        public Message commitModule​(Grant g,
                                    java.lang.String module,
                                    java.lang.String message,
                                    java.lang.String format,
                                    boolean exploded)
        Module commit to Git
        Parameters:
        g - Grant
        module - Module name
        message - Commit message
        format - xml or json
        exploded - Exploded configuration files?
        Returns:
        Message
      • indexation

        public Message indexation​(Grant g)
        (Re)build indexation
        Parameters:
        g - Grant
      • serviceManager

        public Message serviceManager​(Grant g,
                                      java.lang.String object,
                                      java.lang.String service,
                                      java.lang.String[] params)
        Invoke one object's service with text parameters
        Parameters:
        g - Grant
        object - Object name
        service - Service name
        params - Text parameters
        Returns:
        Message
      • serviceManager

        public Message serviceManager​(Grant g,
                                      java.lang.String object,
                                      java.lang.String service,
                                      java.lang.Object[] params)
        Invoke one object's service with any type parameters
        Parameters:
        g - Grant
        object - Object name
        service - Service name
        params - Parameters
        Returns:
        Message
      • purgeLogs

        public Message purgeLogs​(Grant g,
                                 int depth)
        Purge logs
        Parameters:
        g - Grant
        depth - Depth to preserve (negative = number of days to keep, positive = number of records to keep)
        Returns:
        Message
      • purgeJobs

        public Message purgeJobs​(Grant g,
                                 int depth)
        Purge jobs
        Parameters:
        g - Grant
        depth - Depth to preserve (number of days to keep)
        Returns:
        Message
      • purgeSupervisions

        public Message purgeSupervisions​(Grant g,
                                         int depth)
        Purge supervisions
        Parameters:
        g - Grant
        depth - Depth to preserve (number of days to keep)
        Returns:
        Message
      • purgeRecycleBin

        public Message purgeRecycleBin​(Grant g)
        Purge recycle bin
        Parameters:
        g - Grant
        Returns:
        Message
      • purgeExports

        public Message purgeExports​(Grant g)
        Purge exports
        Parameters:
        g - Grant
        Returns:
        Result
      • purgeTempFiles

        public Message purgeTempFiles​(Grant g)
        Purge temp files
        Parameters:
        g - Grant
        Returns:
        Result
      • synchronizeDocs

        public java.lang.String synchronizeDocs​(Grant g)
        Synchronize documents
        Parameters:
        g - Grant
        Returns:
        Result log
      • getLogs

        public java.lang.String getLogs​(Grant g)
        Get logs
        Parameters:
        g - Grant
        Returns:
        Logs
      • runUnitTests

        public java.lang.String runUnitTests​(Grant g,
                                             java.lang.String type,
                                             java.lang.String name)
        Run unit tests
        Parameters:
        g - Grant
        type - Type = configuration object name (e.g. Objectinternal)
        name - Name = configuration object name
        Returns:
        Unit tests output (JSON string)