Package com._1c.g5.v8.dt.platform.services.core.runtimes.execution

Interface IThickClientLauncher

  • All Superinterfaces:
    IRuntimeClientLauncher, IRuntimeComponentExecutor
    All Known Subinterfaces:
    IDesignerSessionThickClientLauncher
    All Known Implementing Classes:
    DesignerSessionThickClientLauncher, ThickClientLauncher
    public interface IThickClientLauncher
extends IRuntimeClientLauncher
    1C:Enterprise runtime component executor for thick client. Can be used to run 1C:Enterprise thick client or perform various actions with infobases or infobase configurations.

    Supported infobase actions:

    • Infobase creation
    • Infobase creation with template
    • Infobase configuration export to XML files
    • Infobase configuration export to mobile application publication XML file
    • Infobase configuration import from XML files
    • Infobase configuration export to *.cf file
    • Infobase configuration import from *.cf file
    • Infobase database update
    • Infobase dump to file
    • Infobase restore from file
    • Dump external objects from *.epf or *.erf files to XML files
    • Restore external objects from XML files to *.epf or *.erf files
    • Check an ability of configuration to apply extensions
    • List infobase configuration extensions
    • Delete infobase configuration extensions

    • Method Detail

      • createInfobase

        void createInfobase​(ILaunchableRuntimeComponent thickClient,
                    InfobaseReference infobase,
                    CreateInfobaseArguments arguments,
                    boolean addReference)
             throws RuntimeExecutionException
        Create new instance of infobase, using given create command (that parameterizes this creation) and the given 1C:Enterprise runtime thick client.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to create, cannot be null
        arguments - arguments that parameterizes creation, cannot be null
        addReference - whether to add reference to created infobase to infobases configuration file
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • createInfobaseUsingTemplate

        void createInfobaseUsingTemplate​(ILaunchableRuntimeComponent thickClient,
                                 InfobaseReference infobase,
                                 CreateInfobaseArguments arguments,
                                 Path templateLocation,
                                 boolean addReference)
                          throws RuntimeExecutionException
        Create new instance of infobase, using given create command (that parameterizes this creation) and the given 1C:Enterprise runtime thick client using the given template.

        Template file location must be provided and have extension *.cf, *.cfu or *.dt.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to create, cannot be null
        arguments - arguments that parameterizes creation, cannot be null
        templateLocation - location of the infobase template, must have extension *.cf, *.cfu or *.dt, cannot be null
        addReference - whether to add reference to created infobase to infobases configuration file
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • runDesigner

        Process runDesigner​(ILaunchableRuntimeComponent thickClient,
                    InfobaseReference infobase,
                    RuntimeExecutionArguments arguments)
             throws RuntimeExecutionException
        Runs 1C:Enterprise Designer on the provided infobase using the given 1C:Enterprise runtime thick client component. Returns the started process.
        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        Returns:
        a pair of launched 1C:Enterprise Designer name and process, never null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • exportConfigurationToXml

        Path exportConfigurationToXml​(ILaunchableRuntimeComponent thickClient,
                              InfobaseReference infobase,
                              ConfigurationFilesFormat format,
                              ConfigurationFilesKind kind,
                              RuntimeExecutionArguments arguments,
                              Path destinationFolder)
                       throws RuntimeExecutionException
        Export configuration as XML files from given infobase to the given folder directory using the given 1C:Enterprise runtime installation thick client.

        Export may be performed for configuration extension to export configuration extension to XML files if provided runtime execution arguments specifies specific extension or all extensions flag.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        format - the format of XML files - plain or hierarchical, cannot be null
        kind - the kind of files - whether need to create plain files or archive file, cannot be null; note that archive configuration files kind ability depens on 1C:Enterprise platform capabilities
        arguments - execution arguments, can be null, then will not be used
        destinationFolder - destination folder to export configuration to, cannot be null
        Returns:
        returns a path to an actual XML files result, may be destination folder or an archive file inside the destination folder if 1C:Enterprise platform support this
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • exportObjectsToXml

        Path exportObjectsToXml​(ILaunchableRuntimeComponent thickClient,
                        InfobaseReference infobase,
                        ConfigurationFilesFormat format,
                        ConfigurationFilesKind kind,
                        RuntimeExecutionArguments arguments,
                        Path destinationFolder,
                        Collection<String> platformQualifiedNames)
                 throws RuntimeExecutionException
        Exports metadata objects with the provided collection of platform qualified object names as XML files from the provided infobase} to the provided folder directory.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        format - the format of XML files - plain or hierarchical, cannot be null
        kind - the kind of files - whether need to create plain files or archive file, cannot be null
        arguments - execution arguments, can be null, then will not be used
        destinationFolder - destination folder to export objects to, cannot be null
        platformQualifiedNames - a collection of platform qualified object names to export, cannot be null or empty
        Returns:
        returns a path to an actual XML files result, may be destination folder or an archive file inside the destination folder if 1C:Enterprise platform support this
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • exportConfigurationToMobileXml

        void exportConfigurationToMobileXml​(ILaunchableRuntimeComponent thickClient,
                                    InfobaseReference infobase,
                                    RuntimeExecutionArguments arguments,
                                    boolean update,
                                    Path destinationFile)
                             throws RuntimeExecutionException
        Export configuration as single XML file from given infobase to the given target file using the given 1C:Enterprise runtime installation thick client. Target XML file will contain entire configuration in a format that can be understood by the 1C:Enterprise mobile runtime.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        update - whether need to update infobase before configuration content export
        destinationFile - destination file to export configuration to, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • getChanges

        void getChanges​(ILaunchableRuntimeComponent thickClient,
                InfobaseReference infobase,
                RuntimeExecutionArguments arguments,
                Path destinationFile)
         throws RuntimeExecutionException
        Exports changes of the provided infobaase since last infobase interaction according to provided infobase configuratuin dump info file in arguments.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, cannot be null, must contain configuratuin dump info file property
        destinationFile - the file to write changes to, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • importConfigurationFromXml

        boolean importConfigurationFromXml​(ILaunchableRuntimeComponent thickClient,
                                   InfobaseReference infobase,
                                   ConfigurationFilesFormat format,
                                   RuntimeExecutionArguments arguments,
                                   Path source)
                            throws RuntimeExecutionException
        Import configuration as XML files to given infobase from given folder directory using the given 1C:Enterprise runtime installation thick client. Performs full configuration XML import.

        If update is true, infobase configuration will be updated after XML import execution, otherwise update infobase is intended to be executed for actual changes applying.

        Import may be performed for configuration extension to import configuration extension from XML files if provided runtime execution arguments specifies specific extension or all extensions flag.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        format - formal of XML files - plain or hierarchical, cannot be null
        arguments - execution arguments, can be null, then will not be used
        source - the XML to import configuration from, may be plain files folder or zip-file, cannot be null
        Returns:
        whether infobase configuration was successfully loaded, false if load was aborted
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • importObjectsFromXml

        boolean importObjectsFromXml​(ILaunchableRuntimeComponent thickClient,
                             InfobaseReference infobase,
                             ConfigurationFilesFormat format,
                             RuntimeExecutionArguments arguments,
                             Path source,
                             Collection<Path> sourceFiles)
                      throws RuntimeExecutionException
        Import configuration as XML files to given infobase from given folder directory using the given 1C:Enterprise runtime installation thick client. Performs incremental XML import: sourceFiles defines, which files to load.

        If update is true, infobase configuration will be updated after XML import execution, otherwise update infobase is intended to be executed for actual changes applying.

        Import may be performed for configuration extension to import configuration extension from XML files if provided runtime execution arguments specifies specific extension or all extensions flag.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        format - formal of XML files - plain or hierarchical, cannot be null
        arguments - execution arguments, can be null, then will not be used
        source - the XML to import object from, may be plain files folder or zip-file, cannot be null
        sourceFiles - a list of exporting files for incremental XML load, cannot be empty
        Returns:
        whether infobase objects was successfully loaded, false if load was aborted
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • exportConfigurationToFile

        void exportConfigurationToFile​(ILaunchableRuntimeComponent thickClient,
                               InfobaseReference infobase,
                               RuntimeExecutionArguments arguments,
                               String extensionName,
                               Path destinationFile)
                        throws RuntimeExecutionException
        Export configuration or configuration extension from the given infobase to the given *.cf or *.cfe file respectively. If extensionName is null, the configuration will be exported. Otherwise, the given extension will be exported.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        extensionName - extension to export or null
        destinationFile - destination file to export configuration to, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • importConfigurationFromCf

        void importConfigurationFromCf​(ILaunchableRuntimeComponent thickClient,
                               InfobaseReference infobase,
                               RuntimeExecutionArguments arguments,
                               Path sourceFile)
                        throws RuntimeExecutionException
        Import configuration to the given infobase from the given *.cf file using the given 1C:Enterprise runtime installation thick client.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        sourceFile - source file to import configuration from, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • updateInfobase

        boolean updateInfobase​(ILaunchableRuntimeComponent thickClient,
                       InfobaseReference infobase,
                       com._1c.g5.designer.ssh.client.operation.IDbUpdateConfirm confirm,
                       RuntimeExecutionArguments arguments)
                throws RuntimeExecutionException
        Update the given infobase database using the given 1C:Enterprise runtime installation thick client. All previously loaded configuration objects will be persisted to the infobase configuration.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        confirm - the callback executed by 1C:Enteprise when database structure changes are received, cannot be null; note that callback may not be executed if confirm is not supported by 1C:Enterprise
        arguments - execution arguments, can be null, then will not be used
        Returns:
        whether infobase configuration was successfully updated, false if update was aborted
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • dumpInfobase

        void dumpInfobase​(ILaunchableRuntimeComponent thickClient,
                  InfobaseReference infobase,
                  RuntimeExecutionArguments arguments,
                  Path destinationFile)
           throws RuntimeExecutionException
        Dump given infobase to the given target file using the given 1C:Enterprise runtime installation thick client.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        destinationFile - destination file to dump infobase to, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • restoreInfobase

        void restoreInfobase​(ILaunchableRuntimeComponent thickClient,
                     InfobaseReference infobase,
                     RuntimeExecutionArguments arguments,
                     Path sourceFile)
              throws RuntimeExecutionException
        Restore given infobase from the given source file using the given 1C:Enterprise runtime installation thick client.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        sourceFile - source file to restore infobase from, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • dumpExternalDataToFiles

        void dumpExternalDataToFiles​(ILaunchableRuntimeComponent thickClient,
                             InfobaseReference infobase,
                             RuntimeExecutionArguments arguments,
                             Path rootSourceFile,
                             Path extarnalDataFile)
                      throws RuntimeExecutionException
        Dumps an external report or data processor to a set of platfom XML files. External report and data processor are represented as *.epf or *.erf files.

        Infobase may be provided to dump execution. If the external data processor includes external references, they are resolved relative to the specified infobase. If the infobase is not specified, external references will be erased.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, can be null to dump external data without infobase usage; if external data contains references to external configuration, these references will be erased
        arguments - execution arguments, can be null, then will not be used
        rootSourceFile - the root file of platform XML etxernal data presentation, cannot be null
        extarnalDataFile - the external data dump file, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • restoreExternalDataFromFiles

        void restoreExternalDataFromFiles​(ILaunchableRuntimeComponent thickClient,
                                  InfobaseReference infobase,
                                  RuntimeExecutionArguments arguments,
                                  Path rootSourceFile,
                                  Path extarnalDataFile)
                           throws RuntimeExecutionException
        Loads an external report or data processor from a set of platfom XML files. External report and data processor are represented as *.epf or *.erf files.

        Infobase may be provided to dump execution. If the external data processor includes external references, they are resolved relative to the specified infobase. If the infobase is not specified, external references will be erased.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, can be null to restore external data without infobase usage; if external data contains references to external configuration, these references will be erased
        arguments - execution arguments, can be null, then will not be used
        rootSourceFile - the root file of platform XML etxernal data presentation, cannot be null
        extarnalDataFile - the external data dump file, cannot be null
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • canApplyConfigurationExtension

        void canApplyConfigurationExtension​(ILaunchableRuntimeComponent thickClient,
                                    InfobaseReference infobase,
                                    RuntimeExecutionArguments arguments,
                                    String extensionName)
                             throws RuntimeExecutionException
        Check an ability of configuration to apply extensions. If extension name is provided then method checks only provided extension, if null is provided as extensionName then method check all configuration extensions.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        extensionName - the name of configuration extension to check or null to check all configuration extensions
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • deleteConfigurationExtension

        void deleteConfigurationExtension​(ILaunchableRuntimeComponent thickClient,
                                  InfobaseReference infobase,
                                  RuntimeExecutionArguments arguments,
                                  String extensionName)
                           throws RuntimeExecutionException
        Deletes configuration extensions. If extension name is provided then method deletes only provided extension, if null is provided as extensionName then method deletes all configuration extensions.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        extensionName - the name of configuration extension to delete or null to delete all configuration extensions
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • listConfigurationExtensions

        List<String> listConfigurationExtensions​(ILaunchableRuntimeComponent thickClient,
                                         InfobaseReference infobase,
                                         RuntimeExecutionArguments arguments)
                                  throws RuntimeExecutionException
        Returns a collection of infobase configuration extension names.

        Started Process is consumed during method execution to read entire process execution log (method is waiting for process termination).

        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        Returns:
        a collection of infobase configuration extension names, never null, may be empty if there are no extensions in infobase configuration
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

      • disableDistributionSupport

        void disableDistributionSupport​(ILaunchableRuntimeComponent thickClient,
                                InfobaseReference infobase,
                                RuntimeExecutionArguments arguments,
                                boolean force)
                         throws RuntimeExecutionException
        Disable distribution configuration support.
        Parameters:
        thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null
        infobase - the infobase reference instance to use, cannot be null
        arguments - execution arguments, can be null, then will not be used
        force - whether need to disable configuration support even if changing the configuration is not allowed
        Throws:
        RuntimeExecutionException - if 1C:Enterprise runtime process execution fails