Interface FrameworkConfig
-
public interface FrameworkConfig
The FrameworkConfig service provides a serviceinterface for other services to access framework (runtime) configuration data from outside the service framework. Any service accessing such data MUST do this through this service.- Author:
- bramk
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
FrameworkConfig.ServerMode
static class
FrameworkConfig.XCEdition
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getApplicationServerName()
Returns the application name.String
getApplicationServerVersion()
Returns the version of the application.String
getBaseDirectory()
String
getBundleDirectory()
String
getCacheDirectory()
String
getClusterNodeId()
Provides the configured cluster identifier for this node.int
getJavaVersion(String version)
Gets the current active java major versionorg.osgi.framework.Version
getPlatformVersion()
String
getProductVersion()
String
getRepositoryDirectory()
FrameworkConfig.ServerMode
getServerMode()
Get the servermode, 'backend' or 'frontend'String
getWebrootDirectory()
FrameworkConfig.XCEdition
getXCEdition()
Returns the xc edition that this installation is.boolean
isClusterMasterNode()
Indicates if this instance is a master node.boolean
isClusterTaskMaster()
Indicates whether this instance is responsible for executing scheduled task that should run at one server at once.boolean
isShuttingDown()
Indicates if the Felix framework is shutting down.void
setXCEdition(FrameworkConfig.XCEdition version)
Sets the xc edition for this installation
-
-
-
Method Detail
-
getBaseDirectory
String getBaseDirectory()
- Returns:
- the framework basedirectory
-
getBundleDirectory
String getBundleDirectory()
- Returns:
- the framework bundledirectory
-
getCacheDirectory
String getCacheDirectory()
- Returns:
- the framework cachedirectory
-
getRepositoryDirectory
String getRepositoryDirectory()
- Returns:
- the framework repositorydirectory
-
getWebrootDirectory
String getWebrootDirectory()
- Returns:
- the framework webrootdirectory
-
getPlatformVersion
org.osgi.framework.Version getPlatformVersion()
- Returns:
- the build version of the WebManager framework.
-
getProductVersion
String getProductVersion()
- Returns:
- the product version of WebManager
-
isClusterMasterNode
boolean isClusterMasterNode()
Indicates if this instance is a master node.- Returns:
- true if this is a master node, else false.
-
isClusterTaskMaster
boolean isClusterTaskMaster()
Indicates whether this instance is responsible for executing scheduled task that should run at one server at once.- Returns:
- true if this is a task master node, else false.
-
getClusterNodeId
String getClusterNodeId()
Provides the configured cluster identifier for this node.- Returns:
- the string identifier for this node.
-
isShuttingDown
boolean isShuttingDown()
Indicates if the Felix framework is shutting down.- Returns:
- true if the Felix framework is shutting down
-
getXCEdition
FrameworkConfig.XCEdition getXCEdition()
Returns the xc edition that this installation is.- Returns:
- the xc edition
-
setXCEdition
void setXCEdition(FrameworkConfig.XCEdition version)
Sets the xc edition for this installation- Parameters:
version
-
-
getJavaVersion
int getJavaVersion(String version)
Gets the current active java major version- Parameters:
version
-
-
getApplicationServerName
String getApplicationServerName()
Returns the application name.- Returns:
- name
-
getApplicationServerVersion
String getApplicationServerVersion()
Returns the version of the application.- Returns:
- version
-
getServerMode
FrameworkConfig.ServerMode getServerMode()
Get the servermode, 'backend' or 'frontend'- Returns:
- ServerMode
-
-