Derek Hulley b687de2f80 Merged DEV to HEAD
52217: MT code cleanup before continuing ALF-19172
          - @Override
          - deprecated TenantAdminService.getAllTenants
          - Add TenantAdminService.getTenants(enabledOnly) ... TODO: not implemented fully, yet
          - Remove unused methods
          - Make internal service methods private
          - Line endings


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@52287 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2013-07-09 13:51:38 +00:00

106 lines
3.2 KiB
Java

/*
* Copyright (C) 2005-2013 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.tenant;
import java.io.File;
import java.util.List;
import org.alfresco.repo.workflow.WorkflowDeployer;
import org.apache.commons.logging.Log;
/**
* Tenant Admin Service interface.
* <p>
* This interface provides administrative methods to provision and administer tenants.
*
*/
public interface TenantAdminService extends TenantUserService
{
public void startTenants();
public void stopTenants();
/*
* Tenant Deployer methods
*/
public void deployTenants(final TenantDeployer deployer, Log logger);
public void undeployTenants(final TenantDeployer deployer, Log logger);
public void register(TenantDeployer tenantDeployer);
public void unregister(TenantDeployer tenantDeployer);
/**
* @return a list of <b>all</b> tenants regardless of state
*
* @deprecated Deprecated in <b>4.2</b>. This method does not scale.
*/
@Deprecated
public List<Tenant> getAllTenants();
/**
* Retrieve all tenants
*
* @param enabledOnly <tt>true</tt> to retrieve only active tenants
* @return tenants, either active or all
*
* @since 4.2
* @deprecated method does not scale.
*/
@Deprecated
public List<Tenant> getTenants(boolean enabledOnly);
/*
* Workflow Deployer methods
*/
public void register(WorkflowDeployer workflowDeployer);
/*
* Admin methods
*/
public void createTenant(String tenantDomain, char[] adminRawPassword);
public void createTenant(String tenantDomain, char[] adminRawPassword, String contentRoot);
// experimental (unsupported)
public void createTenant(String tenantDomain, char[] adminRawPassword, String contentRoot, String dbUrl);
public void exportTenant(String tenantDomain, File directoryDestination);
public void importTenant(String tenantDomain, File directorySource, String contentRoot);
public boolean existsTenant(String tenantDomain);
public void deleteTenant(String tenantDomain);
public void enableTenant(String tenantDomain);
public void disableTenant(String tenantDomain);
public Tenant getTenant(String tenantDomain);
public boolean isEnabledTenant(String tenantDomain);
}