Interface SettingService
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
SettingServiceImpl
@RemoteServiceRelativePath("setting")
public interface SettingService
extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Settings Service. This service allows the
management of various application settings.
- Since:
- 6.0
- Author:
- Matteo Caruso - LogicalDOC
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionloadConverterParameters
(String converter) Loads the parameters of a specified converterLoads email settings (SMTP connection)Load the GUI settingsLoads web services, webDav and other protocol settingsLoads the complete settings setloadSettingsByNames
(List<String> names) Loads a set of settings valuesloadWebserviceStats
(Long tenantId) Loads the usage stats of the webserviceremoveStorage
(int storageId) Tries to delete a storage and fails in case at least one folder is using it and also if the storage is marked as the default write onevoid
saveEmailSettings
(GUIEmailSettings settings) Saves email settings (SMTP connection)void
saveExtensionAliases
(String extension, String aliases) Persists new aliases for the given extensionvoid
saveFirewallSettings
(List<GUIParameter> settings) Saves settings related to the firewallvoid
saveRegistration
(String name, String email, String organization, String website) Saves the registration settingsvoid
saveSettings
(List<GUIParameter> settings) Saves settingsvoid
saveStorageSettings
(List<GUIParameter> settings) Saves settings related to the storageboolean
Tests the SMTP connectionboolean
testStorage
(int id) Tests a storage (read/write access)
-
Method Details
-
loadProtocolSettings
Loads web services, webDav and other protocol settings- Returns:
- the protocol settings
- Throws:
ServerException
- an error happened in the server application
-
loadSettings
Loads the complete settings set- Returns:
- all the settings
- Throws:
ServerException
- an error happened in the server application
-
loadSettingsByNames
Loads a set of settings values- Parameters:
names
- The setting names to be retrieved- Returns:
- The array of settings
- Throws:
ServerException
- an error happened in the server application
-
saveRegistration
void saveRegistration(String name, String email, String organization, String website) throws ServerException Saves the registration settings- Parameters:
name
- person nameemail
- email contactorganization
- organization namewebsite
- the corporate website- Throws:
ServerException
- an error happened in the server application
-
saveSettings
Saves settings- Parameters:
settings
- the settings to save- Throws:
ServerException
- an error happened in the server application
-
loadEmailSettings
Loads email settings (SMTP connection)- Returns:
- the mail server settings
- Throws:
ServerException
- an error happened in the server application
-
testEmail
Tests the SMTP connection- Parameters:
email
- email address to test(it will receive a test message)- Returns:
- True only if the email was sent
- Throws:
ServerException
- an error happened in the server application
-
testStorage
Tests a storage (read/write access)- Parameters:
id
- identifier of the storage to test- Returns:
- True only if the storage has read/write permission
- Throws:
ServerException
- an error happened in the server application
-
saveStorageSettings
Saves settings related to the storage- Parameters:
settings
- the storage settings- Throws:
ServerException
- an error happened in the server application
-
saveFirewallSettings
Saves settings related to the firewall- Parameters:
settings
- the firewall settings- Throws:
ServerException
- an error happened in the server application
-
removeStorage
Tries to delete a storage and fails in case at least one folder is using it and also if the storage is marked as the default write one- Parameters:
storageId
- identifier of the storage to remove- Returns:
- list of paths using the storage
- Throws:
ServerException
- an error happened in the server application
-
saveEmailSettings
Saves email settings (SMTP connection)- Parameters:
settings
- the SMTP settings- Throws:
ServerException
- an error happened in the server application
-
loadGUISettings
Load the GUI settings- Returns:
- the User Interface settings
- Throws:
ServerException
- an error happened in the server application
-
loadConverterParameters
Loads the parameters of a specified converter- Parameters:
converter
- name of the converter- Returns:
- the configuration parameters of the converter
- Throws:
ServerException
- an error happened in the server application
-
loadWebserviceStats
Loads the usage stats of the webservice- Parameters:
tenantId
- identifier of the tenant to consider- Returns:
- all the stats
- Throws:
ServerException
- an error happened in the server application
-
saveExtensionAliases
Persists new aliases for the given extension- Parameters:
extension
- the main file extensionaliases
- comma-separated set of aliases- Throws:
ServerException
- an error happened in the server application
-