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 Summary
Constructors Constructor Description SoapTenantClient(String endpoint)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
deleteTenant(String sid, long tenantId)
Deletes an existing tenant.WSTenant
getTenant(String sid, String name)
Gets a specific tenant by it's nameWSTenant
getTenantById(String sid, long tenantId)
Gets a specific tenant by it's identifierWSTenant[]
listTenants(String sid)
Gets all existing tenants.long
storeTenant(String sid, WSTenant tenant)
Create/Update a tenant.
-
-
-
Constructor Detail
-
SoapTenantClient
public SoapTenantClient(String endpoint) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listTenants
public WSTenant[] listTenants(String sid) throws Exception
Description copied from interface:TenantService
Gets all existing tenants.- Specified by:
listTenants
in interfaceTenantService
- Parameters:
sid
- identifier of the session- Returns:
- The list of tenants
- Throws:
Exception
- database error
-
getTenant
public WSTenant getTenant(String sid, String name) throws Exception
Description copied from interface:TenantService
Gets a specific tenant by it's name- Specified by:
getTenant
in interfaceTenantService
- Parameters:
sid
- identifier of the sessionname
- The tenant's name- Returns:
- A value object containing the tenant metadata.
- Throws:
Exception
- database error
-
getTenantById
public WSTenant getTenantById(String sid, long tenantId) throws Exception
Description copied from interface:TenantService
Gets a specific tenant by it's identifier- Specified by:
getTenantById
in interfaceTenantService
- Parameters:
sid
- identifier of the sessiontenantId
- identifier of the tenant- Returns:
- A value object containing the tenant metadata.
- Throws:
Exception
- database error
-
storeTenant
public long storeTenant(String sid, WSTenant tenant) throws Exception
Description copied from interface:TenantService
Create/Update a tenant. You can completely customize the tenant through a value object.- Specified by:
storeTenant
in interfaceTenantService
- 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:
Exception
- database error
-
deleteTenant
public void deleteTenant(String sid, long tenantId) throws Exception
Description copied from interface:TenantService
Deletes an existing tenant.- Specified by:
deleteTenant
in interfaceTenantService
- Parameters:
sid
- identifier of the session (need to be administrator)tenantId
- identifier of the tenant- Throws:
Exception
- database error
-
-