Package org.alfresco.repo.tenant

Interface TenantAdminService

  • All Superinterfaces:
    org.alfresco.repo.tenant.TenantUserService
    All Known Implementing Classes:
    MultiTAdminServiceImpl, SingleTAdminServiceImpl
    public interface TenantAdminService
extends org.alfresco.repo.tenant.TenantUserService
    Tenant Admin Service interface.

    This interface provides administrative methods to provision and administer tenants.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void createTenant​(java.lang.String tenantDomain, char[] adminRawPassword)  
      void createTenant​(java.lang.String tenantDomain, char[] adminRawPassword, java.lang.String contentRoot)  
      void createTenant​(java.lang.String tenantDomain, char[] adminRawPassword, java.lang.String contentRoot, java.lang.String dbUrl)  
      void deleteTenant​(java.lang.String tenantDomain)  
      void deployTenants​(org.alfresco.repo.tenant.TenantDeployer deployer, org.apache.commons.logging.Log logger)  
      void disableTenant​(java.lang.String tenantDomain)  
      void enableTenant​(java.lang.String tenantDomain)  
      boolean existsTenant​(java.lang.String tenantDomain)  
      void exportTenant​(java.lang.String tenantDomain, java.io.File directoryDestination)  
      java.util.List<org.alfresco.repo.tenant.Tenant> getAllTenants()
      Deprecated.
      Deprecated in 4.2.
      org.alfresco.repo.tenant.Tenant getTenant​(java.lang.String tenantDomain)  
      java.util.List<org.alfresco.repo.tenant.Tenant> getTenants​(boolean enabledOnly)
      Deprecated.
      method does not scale.
      void importTenant​(java.lang.String tenantDomain, java.io.File directorySource, java.lang.String contentRoot)  
      boolean isEnabledTenant​(java.lang.String tenantDomain)  
      void register​(org.alfresco.repo.tenant.TenantDeployer tenantDeployer)  
      void register​(WorkflowDeployer workflowDeployer)  
      void startTenants()  
      void stopTenants()  
      void undeployTenants​(org.alfresco.repo.tenant.TenantDeployer deployer, org.apache.commons.logging.Log logger)  
      void unregister​(org.alfresco.repo.tenant.TenantDeployer tenantDeployer)  

      • Methods inherited from interface org.alfresco.repo.tenant.TenantUserService

        getBaseNameUser, getCurrentUserDomain, getDomainUser, getUserDomain, isEnabled

    • Method Detail

      • startTenants

        void startTenants()

      • stopTenants

        void stopTenants()

      • deployTenants

        void deployTenants​(org.alfresco.repo.tenant.TenantDeployer deployer,
                   org.apache.commons.logging.Log logger)

      • undeployTenants

        void undeployTenants​(org.alfresco.repo.tenant.TenantDeployer deployer,
                     org.apache.commons.logging.Log logger)

      • register

        void register​(org.alfresco.repo.tenant.TenantDeployer tenantDeployer)

      • unregister

        void unregister​(org.alfresco.repo.tenant.TenantDeployer tenantDeployer)

      • getAllTenants

        @Deprecated
java.util.List<org.alfresco.repo.tenant.Tenant> getAllTenants()
        Deprecated.
        Deprecated in 4.2. This method does not scale.
        Returns:
        a list of all tenants regardless of state

      • getTenants

        @Deprecated
java.util.List<org.alfresco.repo.tenant.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

      • createTenant

        void createTenant​(java.lang.String tenantDomain,
                  char[] adminRawPassword)

      • createTenant

        void createTenant​(java.lang.String tenantDomain,
                  char[] adminRawPassword,
                  java.lang.String contentRoot)

      • createTenant

        void createTenant​(java.lang.String tenantDomain,
                  char[] adminRawPassword,
                  java.lang.String contentRoot,
                  java.lang.String dbUrl)

      • exportTenant

        void exportTenant​(java.lang.String tenantDomain,
                  java.io.File directoryDestination)

      • importTenant

        void importTenant​(java.lang.String tenantDomain,
                  java.io.File directorySource,
                  java.lang.String contentRoot)

      • existsTenant

        boolean existsTenant​(java.lang.String tenantDomain)

      • deleteTenant

        void deleteTenant​(java.lang.String tenantDomain)

      • enableTenant

        void enableTenant​(java.lang.String tenantDomain)

      • disableTenant

        void disableTenant​(java.lang.String tenantDomain)

      • getTenant

        org.alfresco.repo.tenant.Tenant getTenant​(java.lang.String tenantDomain)

      • isEnabledTenant

        boolean isEnabledTenant​(java.lang.String tenantDomain)