IVersionedDatabaseUpdateHelper.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apereo.portal.jpa;

import org.apereo.portal.version.om.Version;

public interface IVersionedDatabaseUpdateHelper {
    /** The persistence-unit name for the database this helper applies to */
    String getDatabaseName();

    /**
     * Version of the database this helper should be used to upgrade FROM.
     *
     * <p>If this returns 4.0.2 then this helper will be used when updating from database versions
     * 4.0.0, 4.0.1, and 4.0.2. It will be ignored if updating from database version 4.0.3 or later.
     */
    Version getVersion();

    /** Run before updating to this version */
    void preUpdate();

    /** Run after updating to this version */
    void postUpdate();
}