net.n2oapp.framework.api.register.route.RouteRegister Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of n2o-api Show documentation

There is a newer version: 7.28.1

package net.n2oapp.framework.api.register.route;

import net.n2oapp.framework.api.metadata.Compiled;
import net.n2oapp.framework.api.metadata.compile.CompileContext;

import java.util.Map;

/**
 * Реестр URL адресов метаданных
 */
public interface RouteRegister extends Iterable> {

    /**
     * Регистрация URL адреса метаданной
     *
     * @param urlPattern Шаблон URl адреса метаданной
     * @param context    Контекст сборки метаданной
     */
    void addRoute(String urlPattern, CompileContext context);

    /**
     * Удаление информации об адресах метаданных
     */
    void clearAll();

    /**
     * Синхронизация с репозиторием
     * @return true, если появились новые данные
     */
    default boolean synchronize() {
        return false;
    }
}