org.bonitasoft.engine.platform.Platform 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.platform;

import java.io.Serializable;

/**
 * Contains information about the Bonita Platform.
 * 
 * The platform is the base on which runs the Bonita Engine. There is only one platform for a
 * running Bonita
 * Engine.
 * 

 * In order to perform actions on the platform, please, refer to the {@link org.bonitasoft.engine.api.PlatformAPI}
 *
 * @author Matthieu Chaffotte
 * @see org.bonitasoft.engine.api.PlatformAPI
 * @since 6.0.0
 */
public interface Platform extends Serializable {

    /**
     * Retrieves the platform version
     *
     * @return a String representing the platform version
     * @see #getPreviousVersion()
     * @see #getInitialVersion()
     */
    String getVersion();

    /**
     * This method is deprecated. It used to return the previous version of bonita if the platform was migrated.
     * However this previous version was always exactly the n-1 version compared to the current one.
     *
     * @return an empty string (deprecated)
     * @deprecated since 7.11.0. There is no replacement for this method because previous version is always
     *             deterministic
     */
    @Deprecated
    String getPreviousVersion();

    /**
     * Retrieves the platform initial version. That is, the Bonita version in which you have initially
     * created the platform before migrating
     * to the current version.
     * 
     * For instance, if you have created your platform in the version 6.1.0 and have migrated to the version 6.3.4 using
     * the Bonita Migration
     * Tool, {@code getInitialVersion} will return 6.1.0, {@link #getPreviousVersion()} will return 6.3.3 and
     * {@link #getVersion()} will return 6.3.4.
     *
     * @return a String representing the platform initial version
     * @see #getVersion()
     * @see #getPreviousVersion()
     */
    String getInitialVersion();

    /**
     * Retrieves the timestamp at which the platform was created
     *
     * @return a long representing the timestamp at which the platform was created
     */
    long getCreated();

    /**
     * Retrieves the name of the platform technical user that created the platform
     *
     * @return a String representing the name of the platform technical user that created the platform
     */
    String getCreatedBy();

}