public class TenantMgtAdminService
extends org.wso2.carbon.core.AbstractAdmin
Constructor and Description |
---|
TenantMgtAdminService() |
Modifier and Type | Method and Description |
---|---|
void |
activateTenant(String tenantDomain)
Activate a deactivated tenant, by the super tenant.
|
String |
addSkeletonTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean)
Super admin add tenant.This method will be used whenever the user store is shared between two deployment.
|
String |
addTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean)
Super admin adds a tenant.
|
boolean |
checkDomainAvailability(String domainName)
Check if the selected domain is available to register.
|
void |
deactivateTenant(String tenantDomain)
Deactivate the given tenant
|
void |
deleteTenant(String tenantDomain)
Delete a specific tenant
|
org.wso2.carbon.stratos.common.beans.TenantInfoBean |
getTenant(String tenantDomain)
Get a specific tenant
|
PaginatedTenantInfoBean |
retrievePaginatedPartialSearchTenants(String domain,
int pageNumber)
Method to retrieve all the partial search domain tenants paginated.
|
PaginatedTenantInfoBean |
retrievePaginatedTenants(int pageNumber)
Method to retrieve all the tenants paginated
|
org.wso2.carbon.stratos.common.beans.TenantInfoBean[] |
retrievePartialSearchTenants(String domain)
Retrieve all the tenants which matches the partial search domain.
|
org.wso2.carbon.stratos.common.beans.TenantInfoBean[] |
retrieveTenants()
Retrieve all the tenants.
|
void |
updateTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean)
Updates a given tenant
|
getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp
public String addTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean) throws Exception
tenantInfoBean
- tenant info beanException
- if error in adding new tenant.public boolean checkDomainAvailability(String domainName) throws Exception
domainName
- Domain name.Exception,
- If unable to get the tenant manager, or get the tenant id from manager.Exception
public String addSkeletonTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean) throws Exception
tenantInfoBean
- Exception
public org.wso2.carbon.stratos.common.beans.TenantInfoBean[] retrieveTenants() throws Exception
Exception
- if failed to get Tenant Managerpublic org.wso2.carbon.stratos.common.beans.TenantInfoBean[] retrievePartialSearchTenants(String domain) throws Exception
Exception
- if failed to get Tenant Managerpublic PaginatedTenantInfoBean retrievePaginatedPartialSearchTenants(String domain, int pageNumber) throws Exception
pageNumber
- Number of the page.Exception
- if failed to getTenantManager;public PaginatedTenantInfoBean retrievePaginatedTenants(int pageNumber) throws Exception
pageNumber
- Number of the page.Exception
- if failed to getTenantManager;public org.wso2.carbon.stratos.common.beans.TenantInfoBean getTenant(String tenantDomain) throws Exception
tenantDomain
- tenant domainException
- UserStoreExceptionpublic void updateTenant(org.wso2.carbon.stratos.common.beans.TenantInfoBean tenantInfoBean) throws Exception
tenantInfoBean
- tenant informationException
- UserStoreExceptionpublic void activateTenant(String tenantDomain) throws Exception
tenantDomain
- tenant domainException
- UserStoreException.public void deactivateTenant(String tenantDomain) throws Exception
tenantDomain
- tenant domainException
- UserStoreExceptionpublic void deleteTenant(String tenantDomain) throws org.wso2.carbon.stratos.common.exception.StratosException, org.wso2.carbon.user.api.UserStoreException
tenantDomain
- The domain name of the tenant that needs to be deletedorg.wso2.carbon.stratos.common.exception.StratosException
org.wso2.carbon.user.api.UserStoreException
Copyright © 2020 WSO2. All rights reserved.