public interface ServerConfiguration
Modifier and Type | Interface and Description |
---|---|
static class |
ServerConfiguration.PluggabilityFeaturesConfiguration
The Java Servlet Specification 3.0 introduced "pluggability" features
which require the server to scan web applications for annotations.
|
Modifier and Type | Field and Description |
---|---|
static String |
WEBSTART_CONFIG_ADMIN
Identifier for admin configuration for webstart use.
|
static String |
WEBSTART_CONFIG_CLIENT
Identifier for client configuration for webstart use.
|
Modifier and Type | Method and Description |
---|---|
String |
getActiveWebserverConfiguration(String webAppName)
Gets the active webserver for the named web application.
|
String |
getAdminMail()
Returns the administrators email address used to send notification mails to.
|
String |
getBackupEmail()
Get email address for backup information
|
String |
getClusterFirstSpiritPath()
Gets the path of the cluster server.
|
String |
getClusterMasterHost()
Returns the host of the master cluster server.
|
int |
getClusterMasterPort()
Returns the port of the master cluster server.
|
String |
getClusterSlaveName()
Returns the name of the slave cluster server.
|
String |
getHddDirectories()
Returns directories used for disk space check (comma separated)
|
int |
getHddShutdownLimit()
Limit in percent of hard disk drive space left, the server will be shut down if this limit is exceeded.
|
int |
getHddWarnLimit()
Returns percental limit of hard disk drive space left, a warning mail is issued if this limit is exceeded.
|
Map<String,String> |
getLDAPSections()
Provides a map of LDAP sections.
|
String |
getMemoryLimit()
Returns the maximum percentage of memory to be used.
|
long |
getMemoryMax()
Returns the maximum amount of memory that the Java virtual machine of the server will attempt to use
|
String |
getMotD(String language)
Returns the Message of the Day of the specified language if it exists and should be
visible , otherwise returns null . |
String |
getMotD(String language,
boolean checkActive)
Returns the Message of the Day of the specified language if it exists and checkActive is set to
false , otherwise returns null . |
ServerConfiguration.PluggabilityFeaturesConfiguration |
getPluggabilityFeaturesConfiguration()
Retrieves the configuration of pluggability features for web applications.
|
List<Quickstart> |
getQuickstart()
Returns the list of quickstart items configured.
|
String |
getSelectedWebserverConfiguration(String webAppName)
Deprecated.
since 5.2.180906 - no replacement
|
String |
getSocketPort()
Returns the socket port configured.
|
long |
getStatisticStart()
Convenient accessor for reading the statistic start time (hour of day).
|
ConversionTable |
getUidConversionTable()
Get conversion table used for creating UIDs suggestions from display names.
|
String |
getUrl()
Provides the server's URL.
|
String |
getWebappRoot()
Return the path of the root web application, for an internal servlet engine this is typically "/" and
"/fs5root" for external servlet engines (e.g.
|
int |
getWebmonAjaxImageTimeout()
Returns the in the fs-server.conf specified image reload time out in webmonitor
|
int |
getWebmonAjaxSyncTimeout()
Returns the in the fs-server.conf specified data sync time out for ajax in webmonitor
|
WebstartConfiguration |
getWebstartConfiguration(String name)
Returns the webstart configuration specified by the given name.
|
boolean |
isHddShutdownLimitActive()
Returns whether or not the server will be shut down if space left limit is exceeded.
|
boolean |
isHddWarnLimitActive()
Returns whether or not a warning mail will be issues if space left limit is exceeded.
|
boolean |
isMemoryWarnActive()
Returns
true if the memory warning is enabled. |
boolean |
isMotDVisible()
Returns
true if the Message of the Day is to be shown, false otherwise. |
boolean |
isOutOfMemoryWarnActive()
Returns
true if the out of memory warning for the FirstSpirit server is enabled, false otherwise . |
void |
refresh()
Discard all local changes made to this configuration file.
|
void |
save()
Writes all changes made to this server configuration to the FirstSpirit server
and saves the belonging configuration file.
|
void |
setActiveWebserverConfiguration(String webAppName,
String selectedWebserver)
Sets the configuration of the given webserver as active for the named web application.
|
void |
setAdminMail(String mail)
Sets the administrators email address used to send notification mails to.
|
void |
setClusterFirstSpiritPath(String firstSpiritPath)
Defines the path for the first spirit cluster server.
|
void |
setClusterMasterHost(String host)
Sets the host for the master cluster server.
|
void |
setClusterMasterPort(int port)
Sets the port for the master cluster server.
|
void |
setClusterSlaveName(String slaveName)
Sets the name of the slave cluster server.
|
void |
setHddDirectories(String directories)
Set directories to check the hdd free space left (comma separated).
|
void |
setHddShutdownLimit(int limit)
Set limit in percent of hard disk drive space left, the server will be shut down if this limit is exceeded.
|
void |
setHddShutdownLimitActive(boolean active)
Sets wether or not the server will be shut down if limit is exceeded.
|
void |
setHddWarnLimit(int limit)
Set limit in percent of hard disk drive space left, a warning mail is issued if this limit is exceeded.
|
void |
setHddWarnLimitActive(boolean active)
Sets wether or not a warning mail should be issued if limit is exceeded.
|
void |
setMemoryLimit(String limit)
Sets the maximum percentage of memory to be used.
|
void |
setMemoryWarnActive(boolean active)
Provide
true to enable the memory warning, false otherwise. |
void |
setMotD(String language,
String text)
Sets or deletes the Message of the Day of the specified language.
|
void |
setMotDVisible(boolean show)
Sets whether to show the Message of the Day or not.
|
void |
setOutOfMemoryWarnActive(boolean active)
Activates / deactivates the out of memory warning for the FirstSpirit server.
|
void |
setPluggabilityFeaturesConfiguration(ServerConfiguration.PluggabilityFeaturesConfiguration pluggabilityFeaturesConfiguration)
Sets the configuration of pluggability features for web applications.
|
void |
setQuickstart(List<Quickstart> quickstartList)
Sets the list of quickstart items.
|
void |
setSelectedWebserverConfiguration(String webAppName,
String selectedWebserver)
Deprecated.
since 5.2.180906 - no replacement
|
void |
setStatisticStart(long hour)
Sets the start time for statistics.
|
void |
setUidConversionTable(ConversionTable table)
Set conversion table used for creating UIDs suggestions from display names.
|
void |
setWebstartConfiguration(String name,
WebstartConfiguration config)
Sets the configuration of webstart for the given application.
|
static final String WEBSTART_CONFIG_CLIENT
getWebstartConfiguration(String)
,
Constant Field Valuesstatic final String WEBSTART_CONFIG_ADMIN
getWebstartConfiguration(String)
,
Constant Field Valuesint getWebmonAjaxSyncTimeout()
int getWebmonAjaxImageTimeout()
String getAdminMail()
void setAdminMail(String mail)
mail
- The email address.int getHddWarnLimit()
isHddWarnLimitActive()
boolean isHddWarnLimitActive()
int getHddShutdownLimit()
isHddShutdownLimitActive()
boolean isHddShutdownLimitActive()
getHddShutdownLimit()
String getHddDirectories()
long getMemoryMax()
String getMemoryLimit()
String getMotD(String language, boolean checkActive)
false
, otherwise returns null
.language
- language.checkActive
- check activenull
if it shouldn't be visible or doesn't exist.String getMotD(String language)
visible
, otherwise returns null
.language
- language.null
if it shouldn't be visible or doesn't exist.List<Quickstart> getQuickstart()
@NotNull WebstartConfiguration getWebstartConfiguration(@NotNull String name)
name
- one of WEBSTART_CONFIG_ADMIN
or WEBSTART_CONFIG_CLIENT
long getStatisticStart()
boolean isMemoryWarnActive()
true
if the memory warning is enabled.email address
.true
if the memory warning is enabled.boolean isOutOfMemoryWarnActive()
true
if the out of memory warning for the FirstSpirit server is enabled, false otherwise
.true
if the out of memory warning for the FirstSpirit server is enabled, false otherwise
.boolean isMotDVisible()
true
if the Message of the Day is to be shown, false
otherwise.true
if the Message of the Day is to be shown, false
otherwise.void setHddWarnLimit(int limit)
limit
- limit in percentsetHddWarnLimitActive(boolean)
void setHddWarnLimitActive(boolean active)
active
- warning mail enabled or notsetHddWarnLimit(int)
void setHddShutdownLimit(int limit)
limit
- limit in percentsetHddShutdownLimitActive(boolean)
void setHddShutdownLimitActive(boolean active)
active
- server shut down enabled or notsetHddShutdownLimit(int)
void setHddDirectories(String directories)
directories
- comma separated list of directoriesvoid setMemoryLimit(String limit)
limit
- The maximum percentage of memory to be used.void setMemoryWarnActive(boolean active)
true
to enable the memory warning, false
otherwise.email address
.active
- true
to enable the memory warning, false
otherwise.void setOutOfMemoryWarnActive(boolean active)
save()
to make this change persistent on the FirstSpirit server.void setStatisticStart(long hour)
hour
- The hour of day.void setMotD(String language, String text)
language
- language, for which the MotD should be set.text
- Message of the Day (null
to delete MotD).void setMotDVisible(boolean show)
void setQuickstart(List<Quickstart> quickstartList)
quickstartList
- The list of quickstart items.void setWebstartConfiguration(@NotNull String name, @NotNull WebstartConfiguration config)
name
- Either WEBSTART_CONFIG_CLIENT
or WEBSTART_CONFIG_ADMIN
.config
- The configuration to set.void setActiveWebserverConfiguration(@NotNull String webAppName, @NotNull String selectedWebserver)
webAppName
- The web application name.selectedWebserver
- The name of the webserver to be set active.String getActiveWebserverConfiguration(@NotNull String webAppName)
webAppName
- The web application name.@Deprecated void setSelectedWebserverConfiguration(@NotNull String webAppName, @NotNull String selectedWebserver)
webAppName
- The web application name.selectedWebserver
- The name of the webserver to be set selected.@Deprecated String getSelectedWebserverConfiguration(@NotNull String webAppName)
webAppName
- The web application name.void setPluggabilityFeaturesConfiguration(@NotNull ServerConfiguration.PluggabilityFeaturesConfiguration pluggabilityFeaturesConfiguration)
pluggabilityFeaturesConfiguration
- The configuration value, must not be null
.@NotNull ServerConfiguration.PluggabilityFeaturesConfiguration getPluggabilityFeaturesConfiguration()
null
.Map<String,String> getLDAPSections()
void refresh()
save()
void save()
refresh()
String getSocketPort()
String getWebappRoot()
String getUrl()
void setClusterSlaveName(String slaveName)
getClusterSlaveName()
void setClusterFirstSpiritPath(String firstSpiritPath)
firstSpiritPath
- The path.getClusterFirstSpiritPath()
void setClusterMasterPort(int port)
setClusterMasterHost(String)
,
getClusterMasterHost()
,
getClusterMasterPort()
void setClusterMasterHost(String host)
getClusterMasterHost()
,
getClusterMasterPort()
,
setClusterMasterPort(int)
String getClusterSlaveName()
setClusterSlaveName(String)
String getClusterFirstSpiritPath()
setClusterFirstSpiritPath(String)
int getClusterMasterPort()
getClusterMasterHost()
,
setClusterMasterHost(String)
,
setClusterMasterPort(int)
String getClusterMasterHost()
getClusterMasterPort()
,
setClusterMasterHost(String)
,
setClusterMasterPort(int)
String getBackupEmail()
@NotNull ConversionTable getUidConversionTable()
setUidConversionTable(ConversionTable)
void setUidConversionTable(@NotNull ConversionTable table)
table
- The conversion tablegetUidConversionTable()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210