Package com.logicaldoc.enterprise.webservice.soap.client

Class SoapTenantClient

java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<TenantService>
com.logicaldoc.enterprise.webservice.soap.client.SoapTenantClient
All Implemented Interfaces:
TenantService
public class SoapTenantClient extends com.logicaldoc.webservice.soap.client.SoapClient<TenantService> implements TenantService
Tenant Web Service client.
Since:
7.0.1
Author:
Marco Meschieri - LogicalDOC

  • Constructor Details

    • SoapTenantClient

      public SoapTenantClient(String endpoint)

  • Method Details

    • listTenants

      public WSTenant[] listTenants(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException
      Description copied from interface: TenantService
      Gets all existing tenants.
      Specified by:
      listTenants in interface TenantService
      Parameters:
      sid - identifier of the session
      Returns:
      The list of tenants
      Throws:
      com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated
      com.logicaldoc.webservice.WebserviceException - Error in the webservice
      com.logicaldoc.core.PersistenceException - Error in the data layer

    • getTenant

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

    • getTenantById

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

    • storeTenant

      public long storeTenant(String sid, WSTenant tenant) throws com.logicaldoc.webservice.WebserviceException, FeatureNotEnabledException, com.logicaldoc.core.PersistenceException
      Description copied from interface: TenantService
      Create/Update a tenant. You can completely customize the tenant through a value object.
      Specified by:
      storeTenant in interface TenantService
      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

      public void deleteTenant(String sid, long tenantId)
      Description copied from interface: TenantService
      Deletes an existing tenant.
      Specified by:
      deleteTenant in interface TenantService
      Parameters:
      sid - identifier of the session (need to be administrator)
      tenantId - identifier of the tenant