de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.ServiceOpenApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of FROST-Server.Plugin.OpenApi Show documentation
OpenAPI definition generator for the SensorThings API interface.
There is a newer version: 2.5.0
Show newest version
/*
 * 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.plugin.openapi;

import static de.fraunhofer.iosb.ilt.frostserver.util.Constants.CONTENT_TYPE_APPLICATION_JSON;

import com.fasterxml.jackson.core.JsonProcessingException;
import de.fraunhofer.iosb.ilt.frostserver.formatter.FormatWriterGeneric;
import de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec.GeneratorContext;
import de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec.OADoc;
import de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec.OpenApiGenerator;
import de.fraunhofer.iosb.ilt.frostserver.service.Service;
import de.fraunhofer.iosb.ilt.frostserver.service.ServiceRequest;
import de.fraunhofer.iosb.ilt.frostserver.service.ServiceResponse;
import de.fraunhofer.iosb.ilt.frostserver.settings.CoreSettings;
import de.fraunhofer.iosb.ilt.frostserver.util.SimpleJsonMapper;
import java.io.IOException;
import java.util.List;
import org.slf4j.LoggerFactory;

/**
 * Handles the service requests for the DataArray plugin. This is the request to
 * /api.
 *
 * @author scf
 */
public class ServiceOpenApi {

    /**
     * The path for the OpenApi specification.
     */
    public static final String PATH_GET_OPENAPI_SPEC = "/api";

    /**
     * The RequestType definition for the CreateObservations request type.
     */
    public static final String REQUEST_TYPE_GET_OPENAPI_SPEC = "openApi";

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(ServiceOpenApi.class.getName());

    private final CoreSettings settings;

    public ServiceOpenApi(CoreSettings settings) {
        this.settings = settings;
    }

    public ServiceResponse executeRequest(final ServiceRequest request, ServiceResponse response) {
        GeneratorContext context = new GeneratorContext(settings)
                .initFromRequest(request);
        OADoc oaDoc = OpenApiGenerator.generateOpenApiDocument(context);
        try {
            final String jsonString = SimpleJsonMapper.getSimpleObjectMapper().writeValueAsString(oaDoc);
            response.setCode(200);
            response.setContentType(CONTENT_TYPE_APPLICATION_JSON);
            response.getWriter().append(new FormatWriterGeneric(jsonString).getFormatted());
            return response;
        } catch (JsonProcessingException ex) {
            LOGGER.error("Failed to encode OA Document.", ex);
            return Service.errorResponse(response, 500, "Failed to encode document");
        } catch (IOException ex) {
            LOGGER.error("Failed to format response", ex);
            return Service.errorResponse(response, 500, "Failed to format document");
        }
    }

    public static boolean paramValueAsBool(ServiceRequest request, String name, boolean dflt) {
        List values = request.getParameterMap().get(name);
        if (values == null || values.isEmpty()) {
            return dflt;
        }
        String value = values.get(0);
        if (value == null) {
            return dflt;
        }
        return value.equalsIgnoreCase("true");
    }

    public static int paramValueAsInt(ServiceRequest request, String name, int dflt) {
        List values = request.getParameterMap().get(name);
        if (values == null || values.isEmpty()) {
            return dflt;
        }
        String value = values.get(0);
        if (value == null) {
            return dflt;
        }
        try {
            return Integer.parseInt(value);
        } catch (NumberFormatException e) {
            return dflt;
        }
    }
}