org.nuiton.topia.persistence.TopiaApplicationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
ToPIA API module
The newest version!
package org.nuiton.topia.persistence;

/*
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import com.google.common.collect.ImmutableSet;
import org.nuiton.topia.persistence.support.TopiaServiceSupport;

import java.io.Closeable;
import java.util.List;

/**
 * This is the main entry point for ToPIA. This interface represents the root context of an application.
 *
 * Most of the time, there is only one instance of this context during the entire lifecycle of a application.
 *
 * This contract provides facility to :
 * 
 * create a new {@link org.nuiton.topia.persistence.TopiaPersistenceContext};
 * get meta information about the application (model name, version);
 * get meta information about the entities;
 * do schema related operations;
 * shutdown the application
 * 
 *
 * This contract has an abstract implementation
 * ({@link org.nuiton.topia.persistence.internal.AbstractTopiaApplicationContext}) which is itself extended by a
 * generated {@code AbstractXxxTopiaApplicationContext} (where {@code Xxx} is the project name), itself
 * extended by {@code XxxTopiaApplicationContext}.
 *
 * The full hierarchy is :
  * TopiaApplicationContext (this contract)
 *  \--AbstractTopiaApplicationContext
 *      \--AbstractXxxTopiaApplicationContext (generated)
 *          \--XxxTopiaApplicationContext (generated)
 * 
 * (where {@code Xxx} is the project name)
 *
 * Created on 12/20/13.
 *
 * @author Tony Chemit - [email protected]
 * @since 3.0
 */
public interface TopiaApplicationContext
        extends TopiaServiceSupport, Closeable {

    /**
     * Creates a new instance of XxxTopiaPersistenceContext (where {@code Xxx} is the project name). This is the
     * method to use in order to start a new transaction.
     *
     * @return a newly created instance of your project's specific
     * {@link org.nuiton.topia.persistence.TopiaPersistenceContext}
     * @see org.nuiton.topia.persistence.TopiaPersistenceContext
     */
    K newPersistenceContext();

    String getModelVersion();

    String getModelName();

    String getAuthenticationToken();

     Class getContractClass(Class klass);

     Class getImplementationClass(Class klass);

    Class[] getContractClasses();

    TopiaConfiguration getConfiguration();

    /**
     * Get the list of entities (ToPIA or not) that Hibernate has to handle. By default it only contains ToPIA entities
     * but you may override it to add any other Hibernate entity.
     */
    List> getPersistenceClasses();

    void initSchema();

    boolean isSchemaEmpty();

    boolean isTableExists(Class clazz);

    /**
     * @return the default schema name.
     * @deprecated since 3.0.1, prefer use {@link #getSchemaNames()}.
     */
    @Deprecated
    String getSchemaName();

    /**
     * @return all schema names used by persistent entities.
     * @since 3.0.1
     */
    ImmutableSet getSchemaNames();

    void createSchema();

    void showCreateSchema();

    void updateSchema();

    void dropSchema();

    /**
     * @return true is the application context is opened (ie not yet {@link #isClosed()})
     */
    boolean isOpened();

    /**
     * @return true is the application context is already closed, false otherwise
     */
    boolean isClosed();

    /**
     * Method to call when the application is going for shutdown. It will trigger the shutdown of all the opened
     * children {@link org.nuiton.topia.persistence.TopiaPersistenceContext}
     */
    @Override
    void close();
}