fr.ird.observe.services.service.sql.SqlScriptProducerService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolkit-service Show documentation
ObServe Toolkit Service module
The newest version!
package fr.ird.observe.services.service.sql;

/*-
 * #%L
 * ObServe Toolkit :: Service
 * %%
 * Copyright (C) 2017 - 2021 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import fr.ird.observe.security.Permission;
import fr.ird.observe.services.service.ObserveService;
import fr.ird.observe.services.spi.MethodCredential;
import fr.ird.observe.spi.sql.AddSqlScriptProducerRequest;
import fr.ird.observe.spi.sql.DeleteSqlScriptProducerRequest;
import io.ultreia.java4all.http.spi.Get;
import io.ultreia.java4all.http.spi.Post;
import io.ultreia.java4all.http.spi.Write;
import org.nuiton.topia.persistence.script.TopiaSqlScript;

/**
 * Created on 31/12/15.
 *
 * @author Tony Chemit - [email protected]
 */
public interface SqlScriptProducerService extends ObserveService {

    /**
     * Produce a sql script for the given {@code add request}.
     *
     * Node: permissions are check in the implementation method, since we may not need the same credentials for
     * different requests, some just need READ_REFERENTIAL, other READ_ALL.
     *
     * @param request request to consume
     * @return the generated sql script.
     */
    @Get(useMultiPartForm = true)
    @MethodCredential(Permission.NONE)
    TopiaSqlScript produceAddSqlScript(AddSqlScriptProducerRequest request);

    /**
     * Produce a sql script for the given {@code delete request}.
     *
     * @param request request to consume
     * @return the generated sql script.
     */
    @Get(useMultiPartForm = true)
    @MethodCredential(Permission.READ_ALL)
    TopiaSqlScript produceDeleteSqlScript(DeleteSqlScriptProducerRequest request);

    /**
     * Execute a sql script.
     *
     * @param sqlScript sql script to execute.
     */
    @Post(useMultiPartForm = true)
    @MethodCredential(Permission.READ_ALL_AND_WRITE_DATA)
    @Write
    void executeSqlScript(TopiaSqlScript sqlScript);
}