public interface TenantMgtService
Modifier and Type | Method and Description |
---|---|
void |
activateTenant(String tenantUniqueIdentifier)
Activate a deactivated tenant, by the super tenant.
|
String |
addTenant(org.wso2.carbon.user.core.tenant.Tenant tenant)
Adds a tenant.
|
void |
deactivateTenant(String tenantUniqueIdentifier)
Deactivate the given tenant.
|
void |
deleteTenantMetaData(String tenantUniqueIdentifier)
Delete tenant metadata.
|
org.wso2.carbon.user.core.common.User |
getOwner(String tenantUniqueIdentifier)
Get owner of the tenant using tenant uuid.
|
org.wso2.carbon.user.core.tenant.Tenant |
getTenant(String tenantUniqueIdentifier)
Get a specific tenant using tenant uuid.
|
org.wso2.carbon.user.core.tenant.Tenant |
getTenantByDomain(String domain)
Get a specific tenant using tenant id.
|
boolean |
isDomainAvailable(String domain)
See if the domain is available to be taken.
|
org.wso2.carbon.user.core.tenant.TenantSearchResult |
listTenants(Integer limit,
Integer offset,
String sortOrder,
String sortBy,
String filter)
Retrieve all the tenants.
|
String addTenant(org.wso2.carbon.user.core.tenant.Tenant tenant) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenant
- tenant information.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if error in adding new tenant.org.wso2.carbon.user.core.tenant.TenantSearchResult listTenants(Integer limit, Integer offset, String sortOrder, String sortBy, String filter) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
limit
- limit per page.offset
- offset value.filter
- filter value for tenant search.sortOrder
- order of Tenant ASC/DESC.sortBy
- the column value need to sort.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant listing failed.org.wso2.carbon.user.core.tenant.Tenant getTenant(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if getting the tenant fails.org.wso2.carbon.user.core.tenant.Tenant getTenantByDomain(String domain) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
domain
- tenant domain.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if getting the tenant fails.boolean isDomainAvailable(String domain) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
domain
- tenant domain.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if checking the tenant availability fails.org.wso2.carbon.user.core.common.User getOwner(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if owner retrieval fails.void activateTenant(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if the tenant activation fails.void deactivateTenant(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant deactivation fails.void deleteTenantMetaData(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant deactivation fails.Copyright © 2021 WSO2. All rights reserved.