Package com.e1c.g5.v8.dt.platform.standaloneserver.wst.core

Interface IStandaloneServerService

public interface IStandaloneServerService

Manager service of the 1C:Enterprise Standalone server WST abstractions.

Method Summary

Modifier and Type	Method	Description
org.eclipse.wst.server.core.IServer	createServer(org.eclipse.wst.server.core.IRuntime runtime, org.eclipse.core.runtime.IProgressMonitor monitor)	Creates and returns the new WST server for the provided runtime.
Pair<org.eclipse.wst.server.core.IServer,StandaloneServerInfobase>	createServerWithInfobase(String platformVersion, UUID infobaseId, String infobaseName, Path infobaseLocation, String projectName, org.eclipse.core.runtime.IProgressMonitor monitor)	Creates and returns the new WST server and then created server infobase with the provided parameterns.
URI	getDesignerUrl(StandaloneServerInfobase infobase)	Returns the URL of the 1C:Enterprise Designer launched for the provided cloud infobase.
URI	getInfobaseUrl(StandaloneServerInfobase infobase)	Returns the URL of the 1C:Enterprise Standalone server infobase.
List<org.eclipse.wst.server.core.IRuntime>	getRuntimes()	Returns a list of all known 1C:Enterprise Standalone server runtimes.
Optional<org.eclipse.wst.server.core.IServer>	getServer(StandaloneServerInfobase infobase)	Returns the parent 1C:Enterprise Standalone server for the provided infobase instance.
List<org.eclipse.wst.server.core.IServer>	getServers()	Returns all known instances of 1C:Enterprise Standalone servers.
boolean	validateRuntime(URI location, String version)	Validates the 1C:Enterprise Standalone server runtime installation URI.

Method Detail

getRuntimes

List<org.eclipse.wst.server.core.IRuntime> getRuntimes()

Returns a list of all known 1C:Enterprise Standalone server runtimes.

Returns:

a list of all known 1C:Enterprise Standalone server runtimes, never null

createServer

org.eclipse.wst.server.core.IServer createServer(org.eclipse.wst.server.core.IRuntime runtime,
                                                 org.eclipse.core.runtime.IProgressMonitor monitor)
                                          throws StandaloneServerException

Creates and returns the new WST server for the provided runtime. Server will be configured and named by default.

Parameters:

runtime - the 1C:Enterprise Standalone server runtime, cannot be null

monitor - the progress monitor to report progress to, cannot be null

Returns:

the new WST server for the provided runtime, never null

Throws:

StandaloneServerException - if create failed with some reason

createServerWithInfobase

Pair<org.eclipse.wst.server.core.IServer,StandaloneServerInfobase> createServerWithInfobase(String platformVersion,
                                                                                                  UUID infobaseId,
                                                                                                  String infobaseName,
                                                                                                  Path infobaseLocation,
                                                                                                  String projectName,
                                                                                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                                           throws StandaloneServerException

Creates and returns the new WST server and then created server infobase with the provided parameterns. Returns a pair of the server and infobase.

Parameters:

platformVersion - the 1C:Enterprise platform version to use, cannot be null

infobaseId - the infobase id, cannot be null

infobaseName - the infobase name, cannot be null

infobaseLocation - the file infobase location, cannot be null

projectName - the project name to use for infobase, cannot be null

monitor - the progress monitor to report progress to, cannot be null

Returns:

a pair of created server and infobase, never null

Throws:

StandaloneServerException - if create failed with some reason

getServers

List<org.eclipse.wst.server.core.IServer> getServers()

Returns all known instances of 1C:Enterprise Standalone servers.

Returns:

a list of all known instances of 1C:Enterprise Standalone servers, never null

getServer

Optional<org.eclipse.wst.server.core.IServer> getServer(StandaloneServerInfobase infobase)
                                                 throws StandaloneServerException

Returns the parent 1C:Enterprise Standalone server for the provided infobase instance.

Parameters:

infobase - the 1C:Enterprise Standalone server infobase, cannot be null

Returns:

the parent 1C:Enterprise Standalone server if found

Throws:

StandaloneServerException - if get failed

getDesignerUrl

URI getDesignerUrl(StandaloneServerInfobase infobase)
            throws StandaloneServerException

Returns the URL of the 1C:Enterprise Designer launched for the provided cloud infobase.

Parameters:

infobase - the 1C:Enterprise Standalone server infobase, cannot be null

Returns:

the URL of 1C:Enterprise Designer to use, never null

Throws:

StandaloneServerException - if get failed

getInfobaseUrl

URI getInfobaseUrl(StandaloneServerInfobase infobase)
            throws StandaloneServerException

Returns the URL of the 1C:Enterprise Standalone server infobase.

Parameters:

infobase - the 1C:Enterprise Standalone server infobase, cannot be null

Returns:

the URL of 1C:Enterprise Standalone server infobase, never null

Throws:

StandaloneServerException - if get failed

validateRuntime

boolean validateRuntime(URI location,
                        String version)

Validates the 1C:Enterprise Standalone server runtime installation URI.

Parameters:

location - the 1C:Enterprise server runtime platform location to validate, cannot be null

version - the 1C:Enterprise server version with build, cannot be null