org.bonitasoft.engine.services.PersistenceService Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2011-2013 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.services;

import java.io.IOException;
import java.util.List;
import java.util.Map;

import org.bonitasoft.engine.persistence.PersistentObject;
import org.bonitasoft.engine.persistence.ReadPersistenceService;
import org.bonitasoft.engine.persistence.SRetryableException;

/**
 * @author Charles Souillard
 * @author Elias Ricken de Medeiros
 * @author Celine Souchet
 * @author Matthieu Chaffotte
 */
public interface PersistenceService extends ReadPersistenceService {

    /**
     * Create structure, execute SQL create tenant tables.
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void createStructure() throws SPersistenceException, IOException;

    /**
     * Called after the create structure to execute script after the tables are created
     * e.g. to add indexes and constraints
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void postCreateStructure() throws SPersistenceException, IOException;

    /**
     * Called before the drop structure to execute script before the tables are deleted
     * e.g. to add indexes and constraints
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void preDropStructure() throws SPersistenceException, IOException;

    /**
     * Clean structure, execute SQL clean tables.
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void cleanStructure() throws SPersistenceException, IOException;

    /**
     * Delete structure, execute SQL drop tenant tables.
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void deleteStructure() throws SPersistenceException, IOException;

    /**
     * Initialize structure, execute SQL init tenant tables.
     * 
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     * @since 6.0
     */
    void initializeStructure() throws SPersistenceException, IOException;

    /**
     * @param replacements
     * @throws SPersistenceException
     * @throws IOException
     * @throws SRetryableException
     */
    void initializeStructure(final Map replacements) throws SPersistenceException, IOException;

    // on save, the service MUST generate a unique ID and set it in id attribute if this attribute is equals to -1
    // else keep the already set id
    /**
     * Add a record into the table by given persistentObject.
     * 
     * @param entity
     * @throws SPersistenceException
     * @throws SRetryableException
     * @since 6.0
     */
    void insert(final PersistentObject entity) throws SPersistenceException;

    /**
     * @param entities
     * @throws SPersistenceException
     * @throws SRetryableException
     */
    void insertInBatch(final List entities) throws SPersistenceException;

    /**
     * Delete a record from the table by given persistentObject.
     * 
     * @param entity
     * @throws SPersistenceException
     * @throws SRetryableException
     * @since 6.0
     */
    void delete(final PersistentObject entity) throws SPersistenceException;

    /**
     * Delete elements that are marked to be deleted
     * 
     * @param classToPurge
     *            the class to purge
     * @throws SPersistenceException
     * @throws SRetryableException
     */
    void purge(String classToPurge) throws SPersistenceException;

    /**
     * Delete a record from the table by id and its class type.
     * 
     * @param id
     *            entity's id
     * @param entityClass
     *            The class which extends persistentObject
     * @throws SPersistenceException
     * @throws SRetryableException
     * @since 6.0
     */
    void delete(final long id, final Class entityClass) throws SPersistenceException;

    /**
     * Delete records from the table.
     * 
     * @param ids
     *            A list contains entity ids
     * @param entityClass
     *            The class which extends persistentObject
     * @throws SPersistenceException
     * @throws SRetryableException
     * @since 6.0
     */
    void delete(final List ids, final Class entityClass) throws SPersistenceException;

    /**
     * Delete all records belong to the given entity class from the table.
     * 
     * @param entityClass
     *            The class which extends persistentObject
     * @throws SPersistenceException
     * @throws SRetryableException
     * @since 6.0
     */
    void deleteAll(final Class entityClass) throws SPersistenceException;

    /**
     * @param desc
     * @throws SPersistenceException
     * @throws SRetryableException
     */
    void update(final UpdateDescriptor desc) throws SPersistenceException;

    /**
     * @throws SPersistenceException
     * @throws SRetryableException
     */
    void flushStatements() throws SPersistenceException;

}