de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.tables.TableCollection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of FROST-Server.SQLjooq Show documentation
SQL bindings for the FROST-Server.
There is a newer version: 2.5.0
/*
 * Copyright (C) 2024 Fraunhofer Institut IOSB, Fraunhoferstr. 1, D 76131
 * Karlsruhe, Germany.
 *
 * This program 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, 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 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, see .
 */
package de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.tables;

import static de.fraunhofer.iosb.ilt.frostserver.util.user.PrincipalExtended.ROLE_ADMIN;
import static de.fraunhofer.iosb.ilt.frostserver.util.user.PrincipalExtended.ROLE_CREATE;
import static de.fraunhofer.iosb.ilt.frostserver.util.user.PrincipalExtended.ROLE_DELETE;
import static de.fraunhofer.iosb.ilt.frostserver.util.user.PrincipalExtended.ROLE_UPDATE;

import de.fraunhofer.iosb.ilt.frostserver.model.EntityType;
import de.fraunhofer.iosb.ilt.frostserver.model.ModelRegistry;
import de.fraunhofer.iosb.ilt.frostserver.model.loader.DefModel;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.JooqPersistenceManager;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.factories.EntityFactories;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.utils.validator.CheckUserHasRoles;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.utils.validator.HookValidator;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.utils.validator.SecurityTableWrapper;
import de.fraunhofer.iosb.ilt.frostserver.persistence.pgjooq.utils.validator.ValidatorCUD;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author scf
 */
public class TableCollection {

    /**
     * The logger for this class.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(TableCollection.class);

    private ModelRegistry modelRegistry;
    private boolean initialised = false;

    /**
     * The model definition, stored here as long as the PersistenceManager has
     * not initialised itself using it.
     */
    private List modelDefinitions;
    private Map securityWrappers;
    private Map> securityValidators;

    private final Map> tablesByType = new LinkedHashMap<>();
    private final Map, StaTable> tablesByClass = new LinkedHashMap<>();
    private final Map> tablesByName = new LinkedHashMap<>();

    public TableCollection setModelRegistry(ModelRegistry modelRegistry) {
        this.modelRegistry = modelRegistry;
        return this;
    }

    public StaMainTable getTableForType(EntityType type) {
        return tablesByType.get(type);
    }

    public > T getTableForClass(Class clazz) {
        return (T) tablesByClass.get(clazz);
    }

    public StaTable getTableForName(String name) {
        return tablesByName.get(name);
    }

    public Collection> getAllTables() {
        return tablesByType.values();
    }

    public void registerTable(EntityType type, StaTableAbstract table) {
        tablesByType.put(type, table);
        tablesByClass.put(table.getClass(), table);
        tablesByName.put(table.getName(), table);
        table.init(modelRegistry, this);
    }

    public void registerTable(StaLinkTable table) {
        tablesByClass.put(table.getClass(), table);
        tablesByName.put(table.getName(), table);
    }

    /**
     * Initialise the TableCollection.
     *
     * @param ppm The PersistenceManager to initialise the TableCollection for.
     * @return True if the called caused the TableCollection to be initialised,
     * false if the TableCollection was already initialised and the call made no
     * changes.
     */
    public boolean init(JooqPersistenceManager ppm) {
        if (initialised) {
            return false;
        }
        synchronized (this) {
            if (!initialised) {
                initialised = true;
                final EntityFactories entityFactories = ppm.getEntityFactories();
                for (StaMainTable table : getAllTables()) {
                    LOGGER.info("  Table: {}.", table.getName());
                    table.initProperties(entityFactories);
                    table.initRelations();
                    initSecurityWrapper(table);
                    initSecurityValidators(table, ppm);
                }
                return true;
            }
            return false;
        }
    }

    /**
     * @return the tablesByType
     */
    public Map> getTablesByType() {
        return tablesByType;
    }

    /**
     * The model definitions, stored here as long as the PersistenceManager has
     * not initialised itself using them.
     *
     * @return the modelDefinitions
     */
    public List getModelDefinitions() {
        if (modelDefinitions == null) {
            modelDefinitions = new ArrayList<>();
        }
        return modelDefinitions;
    }

    /**
     * clears the list of model definitions, and makes it immutable.
     */
    public void clearModelDefinitions() {
        this.modelDefinitions = Collections.emptyList();
    }

    public void initSecurityWrapper(StaMainTable table) {
        if (securityWrappers == null) {
            return;
        }
        SecurityTableWrapper stw = securityWrappers.get(table.getName());
        if (stw == null) {
            return;
        }
        table.setSecurityWrapper(stw);
    }

    public void addSecurityWrapper(String tableName, SecurityTableWrapper w) {
        if (securityWrappers == null) {
            securityWrappers = new HashMap<>();
        }
        securityWrappers.put(tableName, w);
    }

    public void initSecurityValidators(StaMainTable table, JooqPersistenceManager ppm) {
        if (securityValidators == null) {
            return;
        }
        final List hvList = securityValidators.get(table.getName());
        if (hvList == null) {
            LOGGER.info("    Adding default security hooks for {}", table.getName());
            HookValidator hv = new ValidatorCUD()
                    .setCheckInsertPreRel(new CheckUserHasRoles().setCheckType(CheckUserHasRoles.Type.ANY).setRoles(ROLE_ADMIN, ROLE_CREATE))
                    .setCheckUpdate(new CheckUserHasRoles().setCheckType(CheckUserHasRoles.Type.ANY).setRoles(ROLE_ADMIN, ROLE_UPDATE))
                    .setCheckDelete(new CheckUserHasRoles().setCheckType(CheckUserHasRoles.Type.ANY).setRoles(ROLE_ADMIN, ROLE_DELETE));
            hv.registerHooks(table, ppm);
            return;
        }
        for (HookValidator hv : hvList) {
            hv.registerHooks(table, ppm);
        }
    }

    public void addSecurityValidator(String tableName, HookValidator hv) {
        if (securityValidators == null) {
            securityValidators = new HashMap<>();
        }
        securityValidators.computeIfAbsent(tableName, tn -> new ArrayList<>())
                .add(hv);
    }
}