Package de.xima.fc.interfaces.server
Interface IServerConfig
-
- All Known Subinterfaces:
IFrontendServerConfig
- All Known Implementing Classes:
DemoServerConfig
public interface IServerConfigCommon interface for server configurations allowing access to server settings and features.- Since:
- 8.2.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Set<String>getFeatures()Returns a set of features this server provides.static IServerConfiggetInstance()Returns the singleton instance of the server configuration via CDI.StringgetServerProperty(String key)Returns the value of the server property with the given key.IntegergetSessionTimeoutMinutes()Set<UserPortal>getUserPortals()Returns all user portals that are enabled on this server.default booleanhasFeature(EServerConfigFeature feature)Returns whether this server configuration has the given feature enabled.default booleanhasFeature(String feature)Returns whether this server configuration has the given feature enabled.
-
-
-
Method Detail
-
getInstance
static IServerConfig getInstance()
Returns the singleton instance of the server configuration via CDI.- Returns:
- the singleton instance of the server configuration.
-
getFeatures
Set<String> getFeatures()
Returns a set of features this server provides.- Returns:
- A set of features this server provides.
-
getUserPortals
Set<UserPortal> getUserPortals()
Returns all user portals that are enabled on this server.- Returns:
- a set of all user portals that are enabled on this server.
-
hasFeature
default boolean hasFeature(String feature)
Returns whether this server configuration has the given feature enabled.- Parameters:
feature- to check.- Returns:
trueif the given server feature is enabled in this server configuration andfalseotherwise.
-
hasFeature
default boolean hasFeature(EServerConfigFeature feature)
Returns whether this server configuration has the given feature enabled.- Parameters:
feature- to check.- Returns:
trueif the given server feature is enabled in this server configuration andfalseotherwise.
-
getServerProperty
String getServerProperty(String key)
Returns the value of the server property with the given key.- Parameters:
key- the key of the server property.- Returns:
- the value of the server property with the given key. If the property does not exist,
nullis returned.
-
getSessionTimeoutMinutes
Integer getSessionTimeoutMinutes()
- Returns:
- the configured session timeout in minutes, or
nullif not configured.
-
-