public class TenantMgtImpl extends Object implements TenantMgtService
TenantMgtService
interface.Modifier and Type | Field and Description |
---|---|
static String |
DOMAIN_NAME |
static String |
INVITE_VIA_EMAIL |
static String |
TENANT_ADMIN_ASK_PASSWORD_CLAIM |
Constructor and Description |
---|
TenantMgtImpl() |
Modifier and Type | Method and Description |
---|---|
void |
activateTenant(int tenantId)
Activate the given tenant by the tenant id.
|
void |
activateTenant(String tenantUniqueID)
Activate a deactivated tenant, by the super tenant.
|
String |
addTenant(org.wso2.carbon.user.core.tenant.Tenant tenant)
Adds a tenant.
|
void |
deactivateTenant(int tenantId)
Deactivate the given tenant by the tenant id.
|
void |
deactivateTenant(String tenantUniqueID)
Deactivate the given tenant by the tenant uuid.
|
void |
deleteTenantMetaData(String tenantUniqueIdentifier)
Delete tenant metadata.
|
org.wso2.carbon.user.core.common.User |
getOwner(String tenantUniqueID)
Get owner of the tenant using tenant uuid.
|
org.wso2.carbon.user.core.tenant.Tenant |
getTenant(String tenantUniqueID)
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.
|
public static final String DOMAIN_NAME
public static final String TENANT_ADMIN_ASK_PASSWORD_CLAIM
public static final String INVITE_VIA_EMAIL
public String addTenant(org.wso2.carbon.user.core.tenant.Tenant tenant) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
addTenant
in interface TenantMgtService
tenant
- tenant information.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if error in adding new tenant.public 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
TenantMgtService
listTenants
in interface TenantMgtService
limit
- limit per page.offset
- offset value.sortOrder
- order of Tenant ASC/DESC.sortBy
- the column value need to sort.filter
- filter value for tenant search.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant listing failed.public org.wso2.carbon.user.core.tenant.Tenant getTenant(String tenantUniqueID) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
getTenant
in interface TenantMgtService
tenantUniqueID
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if getting the tenant fails.public org.wso2.carbon.user.core.tenant.Tenant getTenantByDomain(String domain) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
getTenantByDomain
in interface TenantMgtService
domain
- tenant domain.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if getting the tenant fails.public boolean isDomainAvailable(String domain) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
isDomainAvailable
in interface TenantMgtService
domain
- tenant domain.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if checking the tenant availability fails.public void activateTenant(String tenantUniqueID) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
activateTenant
in interface TenantMgtService
tenantUniqueID
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if the tenant activation fails.public void activateTenant(int tenantId) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
activateTenant
in interface TenantMgtService
tenantId
- tenant id.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant activation fails.public void deactivateTenant(String tenantUniqueID) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
deactivateTenant
in interface TenantMgtService
tenantUniqueID
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant deactivation fails.public void deactivateTenant(int tenantId) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
deactivateTenant
in interface TenantMgtService
tenantId
- tenant id.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant deactivation fails.public void deleteTenantMetaData(String tenantUniqueIdentifier) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
deleteTenantMetaData
in interface TenantMgtService
tenantUniqueIdentifier
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if tenant deactivation fails.public org.wso2.carbon.user.core.common.User getOwner(String tenantUniqueID) throws org.wso2.carbon.stratos.common.exception.TenantMgtException
TenantMgtService
getOwner
in interface TenantMgtService
tenantUniqueID
- tenant uuid.org.wso2.carbon.stratos.common.exception.TenantMgtException
- if owner retrieval fails.Copyright © 2022 WSO2. All rights reserved.