org.graylog2.rest.GenericErrorCsvWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.rest;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.dataformat.csv.CsvGenerator;
import com.fasterxml.jackson.dataformat.csv.CsvMapper;
import com.fasterxml.jackson.dataformat.csv.CsvSchema;
import org.graylog2.plugin.rest.ApiError;
import org.graylog2.plugin.rest.GenericError;
import org.graylog2.plugin.rest.ValidationApiError;

import jakarta.ws.rs.Produces;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.MessageBodyWriter;
import jakarta.ws.rs.ext.Provider;

import java.io.IOException;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

@Provider
@Produces(MoreMediaTypes.TEXT_CSV)
public class GenericErrorCsvWriter implements MessageBodyWriter {
    private final CsvMapper mapper;

    public GenericErrorCsvWriter() {
        this.mapper = new CsvMapper();
        this.mapper.enable(CsvGenerator.Feature.ALWAYS_QUOTE_STRINGS);

        // Required for implicit "type" field
        this.mapper.enable(JsonGenerator.Feature.IGNORE_UNKNOWN);
    }

    @Override
    public long getSize(GenericError genericError, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return -1;
    }

    @Override
    public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return GenericError.class.isAssignableFrom(type)
                && MoreMediaTypes.TEXT_CSV_TYPE.isCompatible(mediaType);
    }

    @Override
    public void writeTo(GenericError genericError,
                        Class type,
                        Type genericType,
                        Annotation[] annotations,
                        MediaType mediaType,
                        MultivaluedMap httpHeaders,
                        OutputStream entityStream) throws IOException, WebApplicationException {

        // Dirty hack for ValidationApiError which cannot be serialized as CSV because of the nested validationErrors field.
        if (genericError instanceof ValidationApiError) {
            final CsvSchema csvSchema = mapper.typedSchemaFor(ApiError.class).withHeader();
            final ApiError apiError = ApiError.create(genericError.message());
            mapper.writerFor(ApiError.class).with(csvSchema).writeValue(entityStream, apiError);
        } else {
            final CsvSchema csvSchema = mapper.typedSchemaFor(type).withHeader();
            mapper.writerFor(type).with(csvSchema).writeValue(entityStream, genericError);
        }
    }
}