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

Interface IDesignerSessionThickClientLauncher

All Superinterfaces:

IRuntimeClientLauncher, IRuntimeComponentExecutor, IThickClientLauncher

All Known Implementing Classes:

DesignerSessionThickClientLauncher

public interface IDesignerSessionThickClientLauncher
extends IThickClientLauncher

IThickClientLauncher extension that is aware of 1C:Enterprise Designer agent configuration sessions.

Method Summary

Modifier and Type	Method	Description
void	closeDesignerSession(ILaunchableRuntimeComponent thickClient, InfobaseReference infobase, RuntimeExecutionArguments arguments)	Closes 1C:Enterprise Designer agent session infobase connection for the provided infobase.
Optional<DebugServerInfo>	getDebugServerUrl(ILaunchableRuntimeComponent thickClient, InfobaseReference infobase, RuntimeExecutionArguments arguments)	Returns the started 1C:Enterprise debug server for the provided thick client and infobase.
Path	openDesignerSession(ILaunchableRuntimeComponent thickClient, InfobaseReference infobase, IDesignerAgentConnectionListener listener, RuntimeExecutionArguments arguments)	Opens 1C:Enterprise Designer agent session infobase connection for the provided infobase.
Path	openDesignerSession(ILaunchableRuntimeComponent thickClient, InfobaseReference infobase, RuntimeExecutionArguments arguments)	Opens 1C:Enterprise Designer agent session infobase connection for the provided infobase.
Process	runDesignerAgent(ILaunchableRuntimeComponent thickClient, InfobaseReference infobase, RuntimeExecutionArguments arguments, Path baseLocation, Integer port)	Runs local 1C:Enterprise Designer agent process with this 1C:Enterprise runtime thick client component.

Methods inherited from interface com._1c.g5.v8.dt.platform.services.core.runtimes.execution.IRuntimeClientLauncher

runClient

Methods inherited from interface com._1c.g5.v8.dt.platform.services.core.runtimes.execution.IRuntimeComponentExecutor

needComponent

Methods inherited from interface com._1c.g5.v8.dt.platform.services.core.runtimes.execution.IThickClientLauncher

canApplyConfigurationExtension, createInfobase, createInfobaseUsingTemplate, deleteConfigurationExtension, disableDistributionSupport, dumpExternalDataToFiles, dumpInfobase, exportConfigurationToFile, exportConfigurationToMobileXml, exportConfigurationToXml, exportObjectsToXml, getChanges, importConfigurationFromCf, importConfigurationFromXml, importObjectsFromXml, listConfigurationExtensions, restoreExternalDataFromFiles, restoreInfobase, runDesigner, updateInfobase

Method Detail

runDesignerAgent

Process runDesignerAgent(ILaunchableRuntimeComponent thickClient,
                         InfobaseReference infobase,
                         RuntimeExecutionArguments arguments,
                         Path baseLocation,
                         Integer port)
                  throws RuntimeExecutionException

Runs local 1C:Enterprise Designer agent process with this 1C:Enterprise runtime thick client component. Launched Designer agent can be used for infobase configuring. 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

baseLocation - a base directory for the SFTP server and for the dump and restore configuration commands, cannot be null

port - the port to start the 1C:Enterprise Designer agent on or null to start on default port

Throws:

RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

openDesignerSession

Path openDesignerSession(ILaunchableRuntimeComponent thickClient,
                         InfobaseReference infobase,
                         RuntimeExecutionArguments arguments)
                  throws RuntimeExecutionException,
                         RuntimeVersionRequiredException

Opens 1C:Enterprise Designer agent session infobase connection for the provided infobase. After session open all configuration thick client operations will be perfromed through this opened session thus these operations will be performed faster. Returns the base directory of the connected 1C:Enterprise Designer agent session.

Clients must close session when no longer needed.

Parameters:

thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null

infobase - the infobase reference instance, cannot be null

arguments - execution arguments, can be null, then will not be used

Returns:

the base directory of the connected 1C:Enterprise Designer agent session, never null

Throws:

RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

RuntimeVersionRequiredException - if 1C:Enterprise runtime installation with provided version and build is required for the operation execution

openDesignerSession

Path openDesignerSession(ILaunchableRuntimeComponent thickClient,
                         InfobaseReference infobase,
                         IDesignerAgentConnectionListener listener,
                         RuntimeExecutionArguments arguments)
                  throws RuntimeExecutionException,
                         RuntimeVersionRequiredException

Opens 1C:Enterprise Designer agent session infobase connection for the provided infobase. After session open all configuration thick client operations will be perfromed through this opened session thus these operations will be performed faster. Returns the base directory of the connected 1C:Enterprise Designer agent session.

Clients must close session when no longer needed.

Parameters:

thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null

infobase - the infobase reference instance, cannot be null

listener - of the designer agent session, cannot be null

arguments - execution arguments, can be null, then will not be used

Returns:

the base directory of the connected 1C:Enterprise Designer agent session, never null

Throws:

RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

RuntimeVersionRequiredException - if 1C:Enterprise runtime installation with provided version and build is required for the operation execution

closeDesignerSession

void closeDesignerSession(ILaunchableRuntimeComponent thickClient,
                          InfobaseReference infobase,
                          RuntimeExecutionArguments arguments)
                   throws RuntimeExecutionException

Closes 1C:Enterprise Designer agent session infobase connection for the provided infobase. After session close all configuration thick client operations will be perfromed through common 1C:Enterprise thick client batch mode.

Parameters:

thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null

infobase - the infobase reference instance, cannot be null

arguments - execution arguments, can be null, then will not be used

Throws:

RuntimeExecutionException - if 1C:Enterprise runtime process execution fails

getDebugServerUrl

Optional<DebugServerInfo> getDebugServerUrl(ILaunchableRuntimeComponent thickClient,
                                            InfobaseReference infobase,
                                            RuntimeExecutionArguments arguments)
                                     throws RuntimeExecutionException

Returns the started 1C:Enterprise debug server for the provided thick client and infobase. May return nothing if the provided infobase is not a client-server or if infobase is not connected to debug agent.

Parameters:

thickClient - the 1C:Enterprise runtime launchable component with thick client, cannot be null

infobase - the infobase reference instance, cannot be null

arguments - execution arguments, can be null, then will not be used

Returns:

the started 1C:Enterprise debug server info

Throws:

RuntimeExecutionException - if 1C:Enterprise runtime process execution fails