001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.migration.handler.impl;
017
018import java.util.List;
019
020import org.slf4j.Logger;
021
022import org.ametys.core.migration.MigrationException;
023import org.ametys.core.migration.configuration.VersionConfiguration;
024import org.ametys.core.migration.version.Version;
025
026/**
027 * Interface that must be implemented by java class used as version handler
028 */
029public interface JavaVersionHandlerComponent
030{
031    /**
032     * Find the current version for a component identifier
033     * @param componentId component to test
034     * @param versionConfiguration configuration to use
035     * @param logger logger that is configured to log this migration
036     * @return the current version for this component (can have a versionId null if no version is found)
037     * @throws MigrationException Something went wrong
038     */
039    List<Version> getVersions(String componentId, VersionConfiguration versionConfiguration, Logger logger) throws MigrationException;
040}