Interface IRuntimeDebugClientTargetManager

  • All Superinterfaces:
    IProcessListener

    public interface IRuntimeDebugClientTargetManager
    extends IProcessListener
    Manager of 1C:Enterprise Runtime debug targets. Manager supports new debug target creation or getting matching 1C:Enterprise Runtime debug client target.

    Clients may use manager to obtain instances of 1C:Enterprise Runtime debug client targets.

    NOTE: 1C:Enterprise supports only one debug connection for one debug web server (equals to one debugServerUrl), so:

    • Clients can use #getRemote(...) or #getLocal(...) to add debug target to some client (method will create necessary debug process launch by itself)
    • Clients can use {@code #createRemote(...) or {@code #createLocal(...)} when they need create exactly new debug connection launch, and they want to create debug process launch by themselves.

    Instances of {@link IRuntimeDebugClientTargetManager} are stateful.

    See Also:
    IRuntimeDebugClientTarget
    • Method Detail

      • createRemote

        IRuntimeDebugClientTarget createRemote​(String debugServerUrl,
                                               String infobaseAlias,
                                               org.eclipse.debug.core.ILaunch launch)
                                        throws org.eclipse.core.runtime.CoreException
        Create new 1C:Enterprise Runtime remote debug client target for given debug web server URL.

        Resulting remote debug client target will be associated with given launch instance. Clients are expected to add target to launch manually, if needed.

        Instance of IProcess will be created and associated with newly created debug target during method execution.

        Parameters:
        debugServerUrl - the debug web server URL, cannot be null
        infobaseAlias - the infobase alias, cannot be null
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if creation fails
      • createRemote

        IRuntimeDebugClientTarget createRemote​(String debugServerUrl,
                                               String debugServerPassword,
                                               String infobaseAlias,
                                               org.eclipse.debug.core.ILaunch launch)
                                        throws org.eclipse.core.runtime.CoreException
        Create new 1C:Enterprise Runtime remote debug client target for given debug web server URL.

        Resulting remote debug client target will be associated with given launch instance. Clients are expected to add target to launch manually, if needed.

        Instance of IProcess will be created and associated with newly created debug target during method execution.

        Parameters:
        debugServerUrl - the debug web server URL, cannot be null
        debugServerPassword - the debug server password or null if none
        infobaseAlias - the infobase alias, cannot be null
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if creation fails
      • getRemote

        IRuntimeDebugClientTarget getRemote​(String debugServerUrl,
                                            String infobaseAlias,
                                            org.eclipse.debug.core.ILaunch launch)
                                     throws org.eclipse.core.runtime.CoreException
        Get 1C:Enterprise Runtime remote debug client target for given debug web server URL. Method can return newly created debug target, or return already existing debug client target, that can be attached to launch.

        Resulting debug client target will not be associated with given launch instance, but still can be added to launch for UI representation by client, if needed.

        Parameters:
        debugServerUrl - the debug web server URL, cannot be null
        infobaseAlias - the infobase alias, cannot be null
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if get fails
      • createLocal

        IRuntimeDebugClientTarget createLocal​(RuntimeInstallation installation,
                                              String infobaseAlias,
                                              int port,
                                              org.eclipse.debug.core.ILaunch launch)
                                       throws org.eclipse.core.runtime.CoreException
        Create new 1C:Enterprise Runtime local debug client target with given project.

        Resulting local debug client target will be associated with given launch instance. Clients are expected to add target to launch manually, if needed.

        Instance of IProcess will be created and associated with newly created debug target during method execution.

        Parameters:
        installation - the 1C:Enterprise Runtime installation to run local debug server for, cannot be null
        infobaseAlias - the infobase alias, cannot be null
        port - the port to start local debug server with, or -1 to determine port automatically
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if get fails
      • getLocal

        IRuntimeDebugClientTarget getLocal​(RuntimeInstallation installation,
                                           String infobaseAlias,
                                           int port,
                                           org.eclipse.debug.core.ILaunch launch)
                                    throws org.eclipse.core.runtime.CoreException
        Get 1C:Enterprise Runtime local debug client target with given project. Method can return newly created debug target, or return already existing debug client target, that can be attached to launch.

        Resulting debug client target will not be associated with given launch instance, but still can be added to launch for UI representation by client, if needed.

        Parameters:
        installation - the 1C:Enterprise Runtime installation to run local debug server for, cannot be null
        infobaseAlias - the infobase alias, cannot be null
        port - the port to start local debug server with, or -1 to determine port automatically
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if get fails
      • createLocal

        IRuntimeDebugClientTarget createLocal​(RuntimeInstallation installation,
                                              InfobaseReference infobase,
                                              int port,
                                              org.eclipse.debug.core.ILaunch launch)
                                       throws org.eclipse.core.runtime.CoreException
        Create new 1C:Enterprise Runtime local debug client target with given project.

        Resulting local debug client target will be associated with given launch instance. Clients are expected to add target to launch manually, if needed.

        Instance of IProcess will be created and associated with newly created debug target during method execution.

        Parameters:
        installation - the 1C:Enterprise Runtime installation to run local debug server for, cannot be null
        infobase - the infobase, cannot be null
        port - the port to start local debug server with, or -1 to determine port automatically
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if get fails
      • getLocal

        IRuntimeDebugClientTarget getLocal​(RuntimeInstallation installation,
                                           InfobaseReference infobase,
                                           int port,
                                           org.eclipse.debug.core.ILaunch launch)
                                    throws org.eclipse.core.runtime.CoreException
        Get 1C:Enterprise Runtime local debug client target with given project. Method can return newly created debug target, or return already existing debug client target, that can be attached to launch.

        Resulting debug client target will not be associated with given launch instance, but still can be added to launch for UI representation by client, if needed.

        Parameters:
        installation - the 1C:Enterprise Runtime installation to run local debug server for, cannot be null
        infobase - the infobase, cannot be null
        port - the port to start local debug server with, or -1 to determine port automatically
        launch - the launch object to contribute processes and debug target to, cannot be null
        Returns:
        the 1C:Enterprise Runtime debug client target, never null
        Throws:
        org.eclipse.core.runtime.CoreException - if get fails