Package com.logicaldoc.gui.frontend.client.services

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

Nested Classes

Modifier and Type	Interface	Description
static class	SettingService.Instance

Method Summary

Modifier and Type	Method	Description
GUIParameter[]	loadConverterParameters(String converter)	Loads the parameters of a specified converter
GUIEmailSettings	loadEmailSettings()	Loads email settings (SMTP connection)
GUIParameter[]	loadGUISettings()	Load the GUI settings
GUIParameter[]	loadProtocolSettings()	Loads web services, webDav and other protocol settings
GUIParameter[]	loadSettings()	Loads the complete settings set
GUIParameter[]	loadSettingsByNames(String[] names)	Loads a set of settings values
GUIParameter[]	loadWebserviceStats(Long tenantId)	Loads the usage stats of the webservice
String[]	removeStorage(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 one
void	saveEmailSettings(GUIEmailSettings settings)	Saves email settings (SMTP connection)
void	saveExtensionAliases(String extension, String aliases)	Persists new aliases for the given extension
void	saveFirewallSettings(GUIParameter[] settings)	Saves settings related to the firewall
void	saveRegistration(String name, String email, String organization, String website)	Saves the registration settings
void	saveSettings(GUIParameter[] settings)	Saves settings
void	saveStorageSettings(GUIParameter[] settings)	Saves settings related to the storage
boolean	testEmail(String email)	Tests the SMTP connection
boolean	testStorage(int id)	Tests a storage (read/write access)

Method Detail

loadProtocolSettings

GUIParameter[] loadProtocolSettings()
                             throws ServerException

Loads web services, webDav and other protocol settings

Returns:

the protocol settings

Throws:

ServerException - an error happened in the server application

loadSettings

GUIParameter[] loadSettings()
                     throws ServerException

Loads the complete settings set

Returns:

all the settings

Throws:

ServerException - an error happened in the server application

loadSettingsByNames

GUIParameter[] loadSettingsByNames(String[] names)
                            throws ServerException

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 name

email - email contact

organization - organization name

website - the corporate website

Throws:

ServerException - an error happened in the server application

saveSettings

void saveSettings(GUIParameter[] settings)
           throws ServerException

Saves settings

Parameters:

settings - the settings to save

Throws:

ServerException - an error happened in the server application

loadEmailSettings

GUIEmailSettings loadEmailSettings()
                            throws ServerException

Loads email settings (SMTP connection)

Returns:

the mail server settings

Throws:

ServerException - an error happened in the server application

testEmail

boolean testEmail(String email)
           throws ServerException

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

boolean testStorage(int id)
             throws ServerException

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

void saveStorageSettings(GUIParameter[] settings)
                  throws ServerException

Saves settings related to the storage

Parameters:

settings - the storage settings

Throws:

ServerException - an error happened in the server application

saveFirewallSettings

void saveFirewallSettings(GUIParameter[] settings)
                   throws ServerException

Saves settings related to the firewall

Parameters:

settings - the firewall settings

Throws:

ServerException - an error happened in the server application

removeStorage

String[] removeStorage(int storageId)
                throws ServerException

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

void saveEmailSettings(GUIEmailSettings settings)
                throws ServerException

Saves email settings (SMTP connection)

Parameters:

settings - the SMTP settings

Throws:

ServerException - an error happened in the server application

loadGUISettings

GUIParameter[] loadGUISettings()
                        throws ServerException

Load the GUI settings

Returns:

the User Interface settings

Throws:

ServerException - an error happened in the server application

loadConverterParameters

GUIParameter[] loadConverterParameters(String converter)
                                throws ServerException

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

GUIParameter[] loadWebserviceStats(Long tenantId)
                            throws ServerException

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

void saveExtensionAliases(String extension,
                          String aliases)
                   throws ServerException

Persists new aliases for the given extension

Parameters:

extension - the main file extension

aliases - comma-separated set of aliases

Throws:

ServerException - an error happened in the server application