public interface AdminService
getService(AdminService.class)
to request an instance of this service.ServicesBroker.getService(Class)
Modifier and Type | Method and Description |
---|---|
void |
createDatabaseLayer(Layer layer)
Creates a new database layer.
|
Layer |
createDatabaseLayer(String name)
Creates a new database layer.
|
Language |
createLanguage(String abbreviation,
String name)
Create a new language.
|
Language |
createLanguage(String abbreviation,
String name,
Locale locale)
Create a new language.
|
void |
deleteLanguage(Language language)
Deletes the given language template on the server
|
Connection |
getConnection() |
Layer |
getDatabaseLayer(String name)
Returns the specified database layer or
null if it doesn't exists. |
Layer[] |
getDatabaseLayers()
Returns all database layers.
|
FontStorage |
getFontStorage() |
Language |
getLanguage(String abbreviation)
Returns the given language or
null . |
List<Language> |
getLanguages()
Get all languages.
|
ProjectStorage |
getProjectStorage()
Returns the server's
ProjectStorage . |
ScheduleStorage |
getScheduleStorage() |
ScriptEngineRegistry |
getScriptEngineRegistry() |
ServerConfiguration |
getServerConfiguration()
Deprecated.
since 4.0.17 - use
Connection.getServerConfiguration() |
Object |
getServerInfo(String name,
String property,
boolean noCache)
Get server related information from server-registered MBeans.
|
String[] |
getUsedLayers(ZipFile exportFile)
Get used database layers.
|
UserStorage |
getUserStorage()
Returns the server's
UserStorage . |
boolean |
isMBeanInstanceOf(String name,
String classString)
Checks if an server-registered MBean exists and is instanceof the specified class.
|
void |
removeDatabaseLayer(Layer layer)
Removes a datbase layer.
|
void |
removeDatabaseLayer(String name)
Removes a datbase layer.
|
void |
restartServer()
Initiates shutdown of the FIRSTspirit Server.
|
void |
serverBackupDone()
Signal that the external server backup is finished.
|
void |
serverBackupPrepare(long prepareTimeout,
long backupTimeout)
Call this method to signal the server to prepare for an external server backup.
|
void |
setDatabaseLayer(Layer layer)
Save changes made on a database layer.
|
void |
setLanguage(Language language)
Write back changed language to the server.
|
void |
stopServer()
Initiates shutdown of the FIRSTspirit Server.
|
void |
testDatabaseLayer(ConnectionConfiguration config)
Tests the given layer-parameters by connecting the sql server.
|
ProjectStorage getProjectStorage()
ProjectStorage
.ProjectStorage
.UserStorage getUserStorage()
UserStorage
.UserStorage
.ScheduleStorage getScheduleStorage()
FontStorage getFontStorage()
ScriptEngineRegistry getScriptEngineRegistry()
@Deprecated ServerConfiguration getServerConfiguration()
Connection.getServerConfiguration()
String[] getUsedLayers(ZipFile exportFile) throws IOException
exportFile
- The export zip fileIOException
Language createLanguage(String abbreviation, String name)
abbreviation
- language abbrevationname
- the nameIllegalArgumentException
- if a language with the given abbreviation already existsSecurityException
- if the user isn't the server admin
Language createLanguage(String abbreviation, String name, Locale locale)
abbreviation
- language abbrevationname
- the namelocale
- the locale, can contain a language different from the lowered abbreviation,
additional country and region informationIllegalArgumentException
- if a language with the given abbreviation already existsSecurityException
- if the user isn't the server admin
void setLanguage(Language language)
language
- the changed languageSecurityException
- if the user isn't the server admin
void deleteLanguage(Language language)
language
- SecurityException
- if the user isn't the server admin
Language getLanguage(String abbreviation)
null
.@Nullable Layer getDatabaseLayer(String name)
null
if it doesn't exists.name
- Layer name.null
.Layer[] getDatabaseLayers()
Layer createDatabaseLayer(String name)
name
- Layer nameIllegalArgumentException
- if a layer with this name already exists.SecurityException
- if the user isn't the server admin
void createDatabaseLayer(Layer layer)
layer
- Layer.IllegalArgumentException
- if a layer with this name already exists.SecurityException
- if the user isn't the server admin
void testDatabaseLayer(ConnectionConfiguration config) throws SQLException
config
- Layer parameters to test.SQLException
- if any occurs during the test.void removeDatabaseLayer(String name)
name
- Layer to remove.IllegalArgumentException
- if the layer doesn't exist.SecurityException
- if the user isn't the server admin
void removeDatabaseLayer(Layer layer)
layer
- Layer to remove.IllegalArgumentException
- if the layer doesn't exist.SecurityException
- if the user isn't the server admin
void setDatabaseLayer(Layer layer)
layer
- Layer to save.IllegalArgumentException
- if the layer doesn't exist.SecurityException
- if the user isn't the server admin
void stopServer()
SecurityException
- if the user isn't the server admin
void restartServer()
SecurityException
- if the user isn't the server admin
Connection getConnection()
Object getServerInfo(String name, String property, boolean noCache)
name
- The name of the information providing MBean.property
- The name of the operation or the attribute to get the value of.noCache
- TODOboolean isMBeanInstanceOf(String name, String classString)
name
- The name of the information providing MBean.classString
- The class name of the mbean, that should be expectedvoid serverBackupPrepare(long prepareTimeout, long backupTimeout) throws TimeoutException
TimeoutException
will be thrown.serverBackupDone()
to signal the server finishing of external backup.prepareTimeout
- The global timeout for the prepare process (in milliseconds)backupTimeout
- After this period the listeners continue with their normal work, even if no serverBackupDone()
(in milliseconds) has been signaledTimeoutException
- thrown if given prepareTimeout is hitserverBackupDone()
void serverBackupDone()
serverBackupPrepare(long, long)
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408