Package com.logicaldoc.web.service

Class SettingServiceImpl

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

com.logicaldoc.web.service.SettingServiceImpl

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, SettingService, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SettingServiceImpl
extends com.google.gwt.user.server.rpc.RemoteServiceServlet
implements SettingService

Implementation of the SettingService

Since:

6.0

Author:

Matteo Caruso - LogicalDOC

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.logicaldoc.gui.frontend.client.services.SettingService

SettingService.Instance

Constructor Summary

Constructors

Constructor	Description
SettingServiceImpl()

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	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)

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

getSerializationPolicy, init, processCall, processCall, processPost

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost

Methods inherited from class javax.servlet.http.HttpServlet

service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingServiceImpl

public SettingServiceImpl()

Method Detail

loadEmailSettings

public GUIEmailSettings loadEmailSettings()
                                   throws ServerException

Description copied from interface: SettingService

Loads email settings (SMTP connection)

Specified by:

loadEmailSettings in interface SettingService

Returns:

the mail server settings

Throws:

ServerException - an error happened in the server application

saveEmailSettings

public void saveEmailSettings(GUIEmailSettings settings)
                       throws ServerException

Description copied from interface: SettingService

Saves email settings (SMTP connection)

Specified by:

saveEmailSettings in interface SettingService

Parameters:

settings - the SMTP settings

Throws:

ServerException - an error happened in the server application

loadSettings

public GUIParameter[] loadSettings()
                            throws ServerException

Description copied from interface: SettingService

Loads the complete settings set

Specified by:

loadSettings in interface SettingService

Returns:

all the settings

Throws:

ServerException - an error happened in the server application

loadProtocolSettings

public GUIParameter[] loadProtocolSettings()
                                    throws ServerException

Description copied from interface: SettingService

Loads web services, webDav and other protocol settings

Specified by:

loadProtocolSettings in interface SettingService

Returns:

the protocol settings

Throws:

ServerException - an error happened in the server application

saveSettings

public void saveSettings(GUIParameter[] settings)
                  throws ServerException

Description copied from interface: SettingService

Saves settings

Specified by:

saveSettings in interface SettingService

Parameters:

settings - the settings to save

Throws:

ServerException - an error happened in the server application

saveStorageSettings

public void saveStorageSettings(GUIParameter[] settings)
                         throws ServerException

Description copied from interface: SettingService

Saves settings related to the storage

Specified by:

saveStorageSettings in interface SettingService

Parameters:

settings - the storage settings

Throws:

ServerException - an error happened in the server application

removeStorage

public String[] removeStorage(int storageId)
                       throws ServerException

Description copied from interface: SettingService

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

Specified by:

removeStorage in interface SettingService

Parameters:

storageId - identifier of the storage to remove

Returns:

list of paths using the storage

Throws:

ServerException - an error happened in the server application

loadSettingsByNames

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

Description copied from interface: SettingService

Loads a set of settings values

Specified by:

loadSettingsByNames in interface SettingService

Parameters:

names - The setting names to be retrieved

Returns:

The array of settings

Throws:

ServerException - an error happened in the server application

loadGUISettings

public GUIParameter[] loadGUISettings()
                               throws ServerException

Description copied from interface: SettingService

Load the GUI settings

Specified by:

loadGUISettings in interface SettingService

Returns:

the User Interface settings

Throws:

ServerException - an error happened in the server application

testEmail

public boolean testEmail(String email)
                  throws ServerException

Description copied from interface: SettingService

Tests the SMTP connection

Specified by:

testEmail in interface SettingService

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

public boolean testStorage(int id)
                    throws ServerException

Description copied from interface: SettingService

Tests a storage (read/write access)

Specified by:

testStorage in interface SettingService

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

saveRegistration

public void saveRegistration(String name,
                             String email,
                             String organization,
                             String website)
                      throws ServerException

Description copied from interface: SettingService

Saves the registration settings

Specified by:

saveRegistration in interface SettingService

Parameters:

name - person name

email - email contact

organization - organization name

website - the corporate website

Throws:

ServerException - an error happened in the server application

loadConverterParameters

public GUIParameter[] loadConverterParameters(String converter)
                                       throws ServerException

Description copied from interface: SettingService

Loads the parameters of a specified converter

Specified by:

loadConverterParameters in interface SettingService

Parameters:

converter - name of the converter

Returns:

the configuration parameters of the converter

Throws:

ServerException - an error happened in the server application

saveExtensionAliases

public void saveExtensionAliases(String extension,
                                 String aliases)
                          throws ServerException

Description copied from interface: SettingService

Persists new aliases for the given extension

Specified by:

saveExtensionAliases in interface SettingService

Parameters:

extension - the main file extension

aliases - comma-separated set of aliases

Throws:

ServerException - an error happened in the server application

loadWebserviceStats

public GUIParameter[] loadWebserviceStats(Long tenantId)
                                   throws ServerException

Description copied from interface: SettingService

Loads the usage stats of the webservice

Specified by:

loadWebserviceStats in interface SettingService

Parameters:

tenantId - identifier of the tenant to consider

Returns:

all the stats

Throws:

ServerException - an error happened in the server application