Package com.e1c.g5.v8.dt.provisioning

Interface IPlatformProvisioningManager

  • public interface IPlatformProvisioningManager
    1C Platform artefact P2 provisioning manager. Manages installations of platform support

    • Field Detail

      • HEADLESS_INSTALLATION_ARGUMENT

        static final String HEADLESS_INSTALLATION_ARGUMENT
        System argument, allowing headless bundles installation in CI & CLI modes
        See Also:
        Constant Field Values

    • Method Detail

      • checkPreviousInstallationFailed

        boolean checkPreviousInstallationFailed​(Version version)
        Checks if there was an error during the last attempt of the platform support installation
        Parameters:
        version - The version of the platform to check the error for. May not be null
        Returns:
        True if the error is registered

      • getPlatformSupportInfo

        List<PlatformSupportStatus> getPlatformSupportInfo()
        Gets the platform support information in form of ordered versions lists with the designation of the installed/not installed status for each platform version
        Returns:
        The list of support statuses for each platform version

      • preparePlatformSupportInstallOperation

        org.eclipse.equinox.p2.operations.InstallOperation preparePlatformSupportInstallOperation​(Version version)
        Prepares the platform support P2 installation operation
        Parameters:
        version - The 1C platform version to install. May not be {@link null}
        Returns:
        The install operation for the given platform. May be null in case if the platform is not supported
        Throws:
        PlatformSupportInstallationException - In case if the communication with the update site/etc is impossible

      • preparePlatformSupportUninstallOperation

        org.eclipse.equinox.p2.operations.UninstallOperation preparePlatformSupportUninstallOperation​(Version version)
        Prepares the platform support P2 uninstallation operation
        Parameters:
        version - The 1C platform version to uninstall support for. May not be {@link null}
        Returns:
        The uninstall operation for the given platform. May be null in case if the platform is not supported/installed
        Throws:
        PlatformSupportInstallationException - In case if the communication with the update site/etc is impossible

      • registerInstallationFailure

        void registerInstallationFailure​(Version version)
        Registers the installation failure for the platform support of the given version
        Parameters:
        version - The version of the platform to register the error for. May not be null

      • resetInstallationFailure

        boolean resetInstallationFailure​(Version version)
        Resets the previously registred installation error for the given version, if any
        Parameters:
        version - The version of the platform to reset the error for. May not be null
        Returns:
        True in case if the error was registered earlier

      • getPlatformBundleNameForVersion

        String getPlatformBundleNameForVersion​(Version version)
        Returns platform bundle name for the received version. Pay no attention if version is invalid - method just add required prefix
        Parameters:
        version - The version of the platform to get bundle name. May not be null
        Returns:
        Bundle name for the required version, not null

      • performInstallation

        org.eclipse.core.runtime.IStatus performInstallation​(org.eclipse.equinox.p2.operations.InstallOperation installOperation,
                                                     String bundleName,
                                                     org.eclipse.core.runtime.IProgressMonitor monitor)
                                              throws InterruptedException
        Method performing bundle installation. Originally is designed for platform, but may be used for others as well
        • Note: install operation must be resolved modally by the caller before method execution if needed
        Parameters:
        installOperation - The provisioning install operation. May not be null
        bundleName - The bundle name to be started after installation. May be null if we ignore bundle launching
        monitor - Parent progress monitor of the performing operation. May be null as it is combined with operation's if needed
        Returns:
        Installation status. May not be null
        Throws:
        InterruptedException

      • performUninstallation

        org.eclipse.core.runtime.IStatus performUninstallation​(org.eclipse.equinox.p2.operations.UninstallOperation uninstallOperation,
                                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                                throws InterruptedException
        Method performing bundle uninstallation. Originally is designed for platform, but may be used for others as well
        • Note: uninstall operation must be resolved modally by the caller before method execution if needed
        Parameters:
        uninstallOperation - The provisioning install operation. May not be null
        monitor - Parent progress monitor of the performing operation. May be null as it's combined with operation's if needed
        Returns:
        Installation status. May not be null
        Throws:
        InterruptedException