de.espirit.firstspirit.access

Interface AdminService

public interface AdminService

FirstSpirit AdminService functions.

Since:

2.3

Method Summary

Methods

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.

Method Detail

getProjectStorage

ProjectStorage getProjectStorage()

Returns the server's ProjectStorage.

Returns:

server's ProjectStorage.

Since:

4.0.17

getUserStorage

UserStorage getUserStorage()

Returns the server's UserStorage.

Returns:

server's UserStorage.

Since:

4.0.17

getScheduleStorage

ScheduleStorage getScheduleStorage()

Since:

4.0.17

getFontStorage

FontStorage getFontStorage()

Since:

4.0.17

getScriptEngineRegistry

ScriptEngineRegistry getScriptEngineRegistry()

Since:

4.0.120

getServerConfiguration

@Deprecated
ServerConfiguration getServerConfiguration()

Deprecated. since 4.0.17 - use Connection.getServerConfiguration()

Returns server properties.

Returns:

server properties.

Since:

4.0.17

getUsedLayers

String[] getUsedLayers(ZipFile exportFile)
                       throws IOException

Get used database layers.

Parameters:

exportFile - The export zip file

Returns:

String array of database layer names

Throws:

IOException

Since:

3.0.87

createLanguage

Language createLanguage(String abbreviation,
                      String name)

Create a new language. The lowered abbreviation is taken as language code. The abbreviation must be unique.

Parameters:

abbreviation - language abbrevation

name - the name

Returns:

the new language

Throws:

IllegalArgumentException - if a language with the given abbreviation already exists

SecurityException - if the user isn't the server admin

Since:

2.3

createLanguage

Language createLanguage(String abbreviation,
                      String name,
                      Locale locale)

Create a new language.

Parameters:

abbreviation - language abbrevation

name - the name

locale - the locale, can contain a language different from the lowered abbreviation, additional country and region information

Returns:

the new language

Throws:

IllegalArgumentException - if a language with the given abbreviation already exists

SecurityException - if the user isn't the server admin

Since:

3.0.13

setLanguage

void setLanguage(Language language)

Write back changed language to the server.

Parameters:

language - the changed language

Throws:

SecurityException - if the user isn't the server admin

Since:

4.0.17

deleteLanguage

void deleteLanguage(Language language)

Deletes the given language template on the server

Parameters:

language -

Throws:

SecurityException - if the user isn't the server admin

Since:

4.0.17

getLanguage

Language getLanguage(String abbreviation)

Returns the given language or null.

Since:

4.0.17

getLanguages

List<Language> getLanguages()

Get all languages.

Returns:

the languages

Since:

4.0.17

getDatabaseLayer

@Nullable
Layer getDatabaseLayer(String name)

Returns the specified database layer or null if it doesn't exists.

Parameters:

name - Layer name.

Returns:

Specified layer or null.

Since:

4.0.17

getDatabaseLayers

Layer[] getDatabaseLayers()

Returns all database layers.

Returns:

All known layers.

Since:

3.0.86

createDatabaseLayer

Layer createDatabaseLayer(String name)

Creates a new database layer.

Parameters:

name - Layer name

Returns:

New layer.

Throws:

IllegalArgumentException - if a layer with this name already exists.

SecurityException - if the user isn't the server admin

Since:

3.0.86

createDatabaseLayer

void createDatabaseLayer(Layer layer)

Creates a new database layer.

Parameters:

layer - Layer.

Throws:

IllegalArgumentException - if a layer with this name already exists.

SecurityException - if the user isn't the server admin

Since:

4.0.17

testDatabaseLayer

void testDatabaseLayer(ConnectionConfiguration config)
                       throws SQLException

Tests the given layer-parameters by connecting the sql server. If no exception occurs, the connection is valid.

Parameters:

config - Layer parameters to test.

Throws:

SQLException - if any occurs during the test.

Since:

4.0.17

removeDatabaseLayer

void removeDatabaseLayer(String name)

Removes a datbase layer.

Parameters:

name - Layer to remove.

Throws:

IllegalArgumentException - if the layer doesn't exist.

SecurityException - if the user isn't the server admin

Since:

4.0.17

removeDatabaseLayer

void removeDatabaseLayer(Layer layer)

Removes a datbase layer.

Parameters:

layer - Layer to remove.

Throws:

IllegalArgumentException - if the layer doesn't exist.

SecurityException - if the user isn't the server admin

Since:

3.0.86

setDatabaseLayer

void setDatabaseLayer(Layer layer)

Save changes made on a database layer.

Parameters:

layer - Layer to save.

Throws:

IllegalArgumentException - if the layer doesn't exist.

SecurityException - if the user isn't the server admin

Since:

3.0.86

stopServer

void stopServer()

Initiates shutdown of the FIRSTspirit Server.

WARNING: All clients will loose their connection the the CMSServer!

Throws:

SecurityException - if the user isn't the server admin

Since:

4.0.17

restartServer

void restartServer()

Initiates shutdown of the FIRSTspirit Server. With exitcode 23. this will restart the Server if it runs with wrapper, in default config of wrapper exitcode 23 will restart the server

WARNING: All clients will loose their connection to the CMSServer!

Throws:

SecurityException - if the user isn't the server admin

Since:

4.0.19

getConnection

Connection getConnection()

Since:

4.0.17

getServerInfo

Object getServerInfo(String name,
                   String property,
                   boolean noCache)

Get server related information from server-registered MBeans. Will first try to access an operation with the given (full) method name. If no such method exists, tries to request an attribute with the given name.

Parameters:

name - The name of the information providing MBean.

property - The name of the operation or the attribute to get the value of.

noCache - TODO

Returns:

The stored value or null.

Since:

4.0.17

isMBeanInstanceOf

boolean isMBeanInstanceOf(String name,
                        String classString)

Checks if an server-registered MBean exists and is instanceof the specified class. For example: To can get ProcessCpuTime, the OperatingSystem MBean must be instanceof "com.sun.management.OperatingSystemMXBean" this method can check something like that

Parameters:

name - The name of the information providing MBean.

classString - The class name of the mbean, that should be expected

Returns:

true if the operation is supported, false otherwise

Since:

4.0.63

serverBackupPrepare

void serverBackupPrepare(long prepareTimeout,
                       long backupTimeout)
                         throws TimeoutException

Call this method to signal the server to prepare for an external server backup. The server tries to prepare for the backup within the given prepareTimeout. If preparation wasn't successful within the prepareTimeout a TimeoutException will be thrown.
After successful preparation the server will resist in backup mode (e.g. reject client requests) for the time specified by backupTimeout. Within this time slot the external backup should be processed. After the time specified by backupTimeout the server will continue with his normal work (e.g. allow client calls).
Call serverBackupDone() to signal the server finishing of external backup.

Parameters:

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 signaled

Throws:

TimeoutException - thrown if given prepareTimeout is hit

Since:

4.2.6

See Also:

serverBackupDone()

serverBackupDone

void serverBackupDone()

Signal that the external server backup is finished. After calling this method the server will return from backup mode and continue with his normal work (e.g. allow client requests).

Since:

4.2.6

See Also:

serverBackupPrepare(long, long)