Interface TenantAdminService

All Superinterfaces:
TenantUserService
All Known Implementing Classes:
MultiTAdminServiceImpl, SingleTAdminServiceImpl

public interface TenantAdminService extends TenantUserService
Tenant Admin Service interface.

This interface provides administrative methods to provision and administer tenants.

  • Method Details

    • startTenants

      void startTenants()
    • stopTenants

      void stopTenants()
    • deployTenants

      void deployTenants(TenantDeployer deployer, org.apache.commons.logging.Log logger)
    • undeployTenants

      void undeployTenants(TenantDeployer deployer, org.apache.commons.logging.Log logger)
    • register

      void register(TenantDeployer tenantDeployer)
    • unregister

      void unregister(TenantDeployer tenantDeployer)
    • getAllTenants

      @Deprecated List<Tenant> getAllTenants()
      Deprecated.
      Deprecated in 4.2. This method does not scale.
      Returns:
      a list of all tenants regardless of state
    • getTenants

      @Deprecated List<Tenant> getTenants(boolean enabledOnly)
      Deprecated.
      method does not scale.
      Retrieve all tenants
      Parameters:
      enabledOnly - true to retrieve only active tenants
      Returns:
      tenants, either active or all
      Since:
      4.2
    • register

      void register(WorkflowDeployer workflowDeployer)
    • createTenant

      void createTenant(String tenantDomain, char[] adminRawPassword)
    • createTenant

      void createTenant(String tenantDomain, char[] adminRawPassword, String contentRoot)
    • createTenant

      void createTenant(String tenantDomain, char[] adminRawPassword, String contentRoot, String dbUrl)
    • exportTenant

      void exportTenant(String tenantDomain, File directoryDestination)
    • importTenant

      void importTenant(String tenantDomain, File directorySource, String contentRoot)
    • existsTenant

      boolean existsTenant(String tenantDomain)
    • deleteTenant

      void deleteTenant(String tenantDomain)
    • enableTenant

      void enableTenant(String tenantDomain)
    • disableTenant

      void disableTenant(String tenantDomain)
    • getTenant

      Tenant getTenant(String tenantDomain)
    • isEnabledTenant

      boolean isEnabledTenant(String tenantDomain)