Package com.logicaldoc.web.service

Class SettingServiceImpl

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

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

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

com.logicaldoc.web.service.AbstractRemoteService

com.logicaldoc.web.service.SettingServiceImpl

All Implemented Interfaces:

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

public class SettingServiceImpl
extends AbstractRemoteService
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

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
SettingServiceImpl()

Method Summary

Modifier and Type	Method	Description
List<GUIParameter>	loadAuditingSettings()	Load the auditing settings
List<GUIParameter>	loadConverterParameters(String converter)	Loads the parameters of a specified converter
GUIEmailSettings	loadEmailSettings()	Loads email settings (SMTP connection)
List<GUIParameter>	loadGUISettings()	Load the GUI settings
List<GUIParameter>	loadProtocolSettings()	Loads web services, webDav and other protocol settings
List<GUIParameter>	loadSettings()	Loads the complete settings set
List<GUIParameter>	loadSettingsByNames(List<String> names)	Loads a set of settings values
List<GUIParameter>	loadWebserviceStats(Long tenantId)	Loads the usage stats of the webservice
List<String>	removeStore(int storeId)	Tries to delete a store and fails in case at least one folder is using it and also if the store 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(List<GUIParameter> settings)	Saves settings related to the firewall
void	saveRegistration(String name, String email, String organization, String website)	Saves the registration settings
void	saveSettings(List<GUIParameter> settings)	Saves settings
void	saveStoreSettings(List<GUIParameter> settings)	Saves settings related to the store
boolean	testEmail(String email)	Tests the SMTP connection
Boolean	testProxy(String host, int port, String username, String password)	Tests the connection to a proxy
boolean	testStore(int id)	Tests a store (read/write access)

Methods inherited from class com.logicaldoc.web.service.AbstractRemoteService

setThreadRequest

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

getSerializationPolicy, init, processCall, processCall, processPost

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

doPost

Methods inherited from class jakarta.servlet.http.HttpServlet

service

Methods inherited from class jakarta.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 Details

SettingServiceImpl

public SettingServiceImpl()

Method Details

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 List<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 List<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(List<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

saveFirewallSettings

public void saveFirewallSettings(List<GUIParameter> settings)
                          throws ServerException

Description copied from interface: SettingService

Saves settings related to the firewall

Specified by:

saveFirewallSettings in interface SettingService

Parameters:

settings - the firewall settings

Throws:

ServerException - an error happened in the server application

saveStoreSettings

public void saveStoreSettings(List<GUIParameter> settings)
                       throws ServerException

Description copied from interface: SettingService

Saves settings related to the store

Specified by:

saveStoreSettings in interface SettingService

Parameters:

settings - the store settings

Throws:

ServerException - an error happened in the server application

removeStore

public List<String> removeStore(int storeId)
                         throws ServerException

Description copied from interface: SettingService

Tries to delete a store and fails in case at least one folder is using it and also if the store is marked as the default write one

Specified by:

removeStore in interface SettingService

Parameters:

storeId - identifier of the store to remove

Returns:

list of paths using the store

Throws:

ServerException - an error happened in the server application

loadSettingsByNames

public List<GUIParameter> loadSettingsByNames(List<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 List<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

testStore

public boolean testStore(int id)
                  throws ServerException

Description copied from interface: SettingService

Tests a store (read/write access)

Specified by:

testStore in interface SettingService

Parameters:

id - identifier of the store to test

Returns:

True only if the store 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 List<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 List<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

loadAuditingSettings

public List<GUIParameter> loadAuditingSettings()
                                        throws ServerException

Description copied from interface: SettingService

Load the auditing settings

Specified by:

loadAuditingSettings in interface SettingService

Returns:

the User Interface settings

Throws:

ServerException - an error happened in the server application

testProxy

public Boolean testProxy(String host,
 int port,
 String username,
 String password)
                  throws ServerException

Description copied from interface: SettingService

Tests the connection to a proxy

Specified by:

testProxy in interface SettingService

Parameters:

host - the proxy host name

port - the proxy port

username - the username to connect to the proxy

password - the password to connect to the proxy

Returns:

if the connection has been succesful or not

Throws:

ServerException - an error happened in the server application