de.espirit.firstspirit.module
Interface ServerEnvironment

All Known Subinterfaces:

ProjectEnvironment, WebEnvironment

public interface ServerEnvironment

Method Summary

FileSystem<? extends de.espirit.firstspirit.io.FileHandle>	getConfDir() Returns the configuration directory of this environment.
Connection	getConnection() Returns the connection.
FileSystem<? extends de.espirit.firstspirit.io.FileHandle>	getDataDir() Returns the data directory of this environment.
String	getInstalledVersion() Returns the installed version of the component.
FileSystem<? extends de.espirit.firstspirit.io.FileHandle>	getLogDir() Returns the FileSystem as access to the log directory of this environment.
ComponentDescriptor.Scope	getScope() Returns the scope, one of ComponentDescriptor.Scope.SERVER, ComponentDescriptor.Scope.PROJECT, and ComponentDescriptor.Scope.WEB.

Method Detail

getConfDir

@NotNull
FileSystem<? extends de.espirit.firstspirit.io.FileHandle> getConfDir()

Returns the configuration directory of this environment.

Returns:

configuration directory of this environment.

Since:

4.1

getDataDir

@Nullable
FileSystem<? extends de.espirit.firstspirit.io.FileHandle> getDataDir()

Returns the data directory of this environment.
Components which uses this environment should store their data files in this directory.

Returns:

data directory of this environment

Since:

4.1

getLogDir

@Nullable
FileSystem<? extends de.espirit.firstspirit.io.FileHandle> getLogDir()

Returns the FileSystem as access to the log directory of this environment.
Components which uses this environment should store their log files in this directory.

Returns:

the FileSystem as access to the log directory of this environment

Since:

4.1

getConnection

Connection getConnection()

Returns the connection.

Returns:

connection

Since:

4.1

getScope

ComponentDescriptor.Scope getScope()

Returns the scope, one of ComponentDescriptor.Scope.SERVER, ComponentDescriptor.Scope.PROJECT, and ComponentDescriptor.Scope.WEB.

Returns:

scope

Since:

4.1

getInstalledVersion

String getInstalledVersion()

Returns the installed version of the component.

Returns:

installed version string of the component

Since:

4.1.44