Package com.logicaldoc.webservice.soap

Interface SystemService

All Known Implementing Classes:

RestSystemService, RestSystemSwagger, SoapSystemClient, SoapSystemService

public interface SystemService

System Web Service definition interface

Since:

6.1

Author:

Matteo Caruso - LogicalDOC

Method Summary

Modifier and Type	Method	Description
WSSystemInfo	getInfo()	Retrieves the Installation informations
List<String>	getLanguages(String tenantOrSid)	Retrieves the languages enabled in the server.
List<WSParameter>	getStatistics(String sid)	Retrieves the system statistics
List<WSParameter>	getTenantStatistics(String sid, long tenantId)	Retrieves the statistics of a tenenat

Method Details

getInfo

WSSystemInfo getInfo()
              throws WebserviceException

Retrieves the Installation informations

Returns:

The value object containing the installation informations

Throws:

WebserviceException - Error in the webservice

getStatistics

List<WSParameter> getStatistics(String sid)
                         throws AuthenticationException,
WebserviceException,
PersistenceException

Retrieves the system statistics

Parameters:

sid - Session identifier

Returns:

List of stats

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getTenantStatistics

List<WSParameter> getTenantStatistics(String sid,
 long tenantId)
                               throws AuthenticationException,
WebserviceException,
PersistenceException

Retrieves the statistics of a tenenat

Parameters:

sid - Session identifier

tenantId - Identifier of the tenant

Returns:

List of stats

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getLanguages

List<String> getLanguages(String tenantOrSid)

Retrieves the languages enabled in the server.

Parameters:

tenantOrSid - Tenant name or session identifier (optional)

Returns:

Array of active languages (en, it, es ....)