Package com.logicaldoc.enterprise.webservice.soap

Interface TenantService

All Known Implementing Classes:
SoapTenantClient, SoapTenantService
public interface TenantService
This web service allows the administrator to handle the tenants
Since:
7.1
Author:
Marco Meschieri - LogicalDOC

  • Method Details

    • listTenants

      List<WSTenant> listTenants(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Gets all existing tenants.
      Parameters:
      sid - identifier of the session
      Returns:
      The list of tenants
      Throws:
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

    • getTenant

      WSTenant getTenant(String sid, String name) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.PersistenceException
      Gets a specific tenant by it's name
      Parameters:
      sid - identifier of the session
      name - The tenant's name
      Returns:
      A value object containing the tenant metadata.
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

    • getTenantById

      WSTenant getTenantById(String sid, long tenantId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.core.PersistenceException
      Gets a specific tenant by it's identifier
      Parameters:
      sid - identifier of the session
      tenantId - identifier of the tenant
      Returns:
      A value object containing the tenant metadata.
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

    • storeTenant

      long storeTenant(String sid, WSTenant tenant) throws com.logicaldoc.webservice.WebserviceException, FeatureNotEnabledException, com.logicaldoc.core.PersistenceException
      Create/Update a tenant. You can completely customize the tenant through a value object.
      Parameters:
      sid - identifier of the session (need to be administrator)
      tenant - Web service value object containing the tenant's metadata
      Returns:
      The value object containing the tenant's metadata.
      Throws:
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer

    • deleteTenant

      void deleteTenant(String sid, long tenantId) throws com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.security.authorization.PermissionException, FeatureNotEnabledException, com.logicaldoc.core.PersistenceException
      Deletes an existing tenant.
      Parameters:
      sid - identifier of the session (need to be administrator)
      tenantId - identifier of the tenant
      Throws:
      com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      FeatureNotEnabledException - The feature is not enabled in the license
      com.logicaldoc.core.PersistenceException - Error in the data layer