org.bonitasoft.engine.api.TenantAdministrationAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-common Show documentation
Bonita Common is the useful layer common to bonita-client and bonita-server
There is a newer version: 10.2.0
/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library 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
 * version 2.1 of the License.
 * This library 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 this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.api;

import org.bonitasoft.engine.business.data.BusinessDataRepositoryDeploymentException;
import org.bonitasoft.engine.business.data.BusinessDataRepositoryException;
import org.bonitasoft.engine.business.data.InvalidBusinessDataModelException;
import org.bonitasoft.engine.exception.UpdateException;
import org.bonitasoft.engine.tenant.TenantResource;

/**
 * This API gives access to tenant administration tasks.
 *
 * @author Matthieu Chaffotte
 * @author Baptiste Mesta
 */
public interface TenantAdministrationAPI {

    /** A String key to designate the functional scope of updating the BDM */
    public static final String UPDATE_BDM = "UpdateBDM";

    /**
     * @return
     *         true if the tenant is paused.
     * @deprecated since 9.0.0, use {@link MaintenanceAPI#getMaintenanceDetails()} instead.
     */
    @Deprecated(since = "9.0.0", forRemoval = true)
    boolean isPaused();

    /**
     * Pause the tenant so nothing is executed anymore.
     * when the tenant is paused:
     * Only technical user can login when the tenant is paused.
     * All users connected are disconnected (apart from the technical user).
     * Only IdentityAPI and ProfileAPI are accessible.
     *
     * @deprecated since 9.0.0, use {@link MaintenanceAPI#enableMaintenanceMode()} instead.
     * @throws org.bonitasoft.engine.exception.UpdateException
     *         if the tenant cannot be paused.
     */
    @Deprecated(since = "9.0.0", forRemoval = true)
    void pause() throws UpdateException;

    /**
     * Resume the tenant to a normal state after a pause.
     *
     * @deprecated since 9.0.0, use {@link MaintenanceAPI#disableMaintenanceMode()} instead.
     * @throws org.bonitasoft.engine.exception.UpdateException
     *         if the tenant cannot be resumed.
     */
    @Deprecated(since = "9.0.0", forRemoval = true)
    void resume() throws UpdateException;

    /**
     * Uninstalls the business data model.
     *
     * @throws BusinessDataRepositoryDeploymentException
     *         if the deployment cannot be fulfilled completely.
     */
    void uninstallBusinessDataModel() throws BusinessDataRepositoryDeploymentException;

    /**
     * Update the business data model.
     *
     * @param zip
     *        the binary content of the business object model.
     * @return the version of the Business Data Model just deployed.
     * @throws InvalidBusinessDataModelException
     *         if the Business Data Model content passed as parameter is invalid.
     * @throws BusinessDataRepositoryDeploymentException
     *         if the deployment cannot be fulfilled completely.
     * @deprecated as of 9.0.0. The BDM should only be updated at startup.
     */
    @Deprecated(since = "9.0.0")
    String updateBusinessDataModel(final byte[] zip)
            throws InvalidBusinessDataModelException, BusinessDataRepositoryDeploymentException;

    /**
     * Deletes all business data and uninstalls the business data model.
     *
     * @throws BusinessDataRepositoryDeploymentException
     *         if the deployment cannot be fulfilled completely.
     */
    void cleanAndUninstallBusinessDataModel() throws BusinessDataRepositoryDeploymentException;

    /**
     * Returns the generated BDM zip.
     * This zip contains the jars with BDM Pojos and DAOs.
     * usage:
     * byte[] clientBDMZip = getTenantAdministrationAPI().getClientBDMZip();
     * clientBDMZip will typically contain : "README.md", "example-pom.xml", "bdm-dao.jar", "bdm-model.jar", "bom.zip".
     * See online a Java
     * code example
     * on how to extract those artefacts from the Zip file.
     *
     * @return zip content of the deployed client Business data model, null if no Business data model has been deployed
     * @throws BusinessDataRepositoryException
     *         if the Business Data Model cannot be retrieved.
     */
    byte[] getClientBDMZip() throws BusinessDataRepositoryException;

    /**
     * Returns the current Business Data Model version, if any, or null if no Business Data Model is currently deployed.
     *
     * @return the current Business Data Model version, if any, or null if no Business Data Model is currently deployed
     * @throws BusinessDataRepositoryException
     *         if the BDM version cannot be retrieved properly.
     */
    String getBusinessDataModelVersion() throws BusinessDataRepositoryException;

    /**
     * Retrieves the BDM resource, as a tenant-level resource. Or NONE if no BDM is installed.
     *
     * @return a TenantResource representing the current BDM on the current tenant,
     *         or TenantResource.NONE if no BDM is installed.
     * @since 7.7
     */
    TenantResource getBusinessDataModelResource();

}