org.graylog2.contentpacks.model.LegacyContentPack 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.contentpacks.model;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonView;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableSet;
import org.bson.types.ObjectId;
import org.graylog2.contentpacks.model.constraints.Constraint;
import org.graylog2.contentpacks.model.entities.Entity;
import org.graylog2.contentpacks.model.entities.EntityV1;
import org.graylog2.contentpacks.model.parameters.Parameter;

import javax.annotation.Nullable;
import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.UUID;
import java.util.stream.Collectors;

@AutoValue
@JsonAutoDetect
@JsonDeserialize(builder = LegacyContentPack.Builder.class)
public abstract class LegacyContentPack implements ContentPack {
    private static final ModelVersion VERSION = ModelVersion.of("0");
    private static final String FIELD_NAME = "name";
    private static final String FIELD_SUMMARY = "summary";
    private static final String FIELD_DESCRIPTION = "description";
    private static final String FIELD_VENDOR = "vendor";
    private static final String FIELD_URL = "url";
    private static final String FIELD_REQUIRES = "requires";
    private static final String FIELD_PARAMETERS = "parameters";
    private static final String FIELD_ENTITIES = "entities";
    private static final String FIELD_DB_ID = "_id";

    private static final int DEFAULT_REVISION = 0;

    @Nullable
    @JsonView(ContentPackView.DBView.class)
    @JsonProperty(FIELD_DB_ID)
    public abstract ObjectId _id();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_NAME)
    public abstract String name();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_SUMMARY)
    public abstract String summary();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_DESCRIPTION)
    public abstract String description();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_VENDOR)
    public abstract String vendor();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_URL)
    public abstract URI url();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_REQUIRES)
    public abstract ImmutableSet requires();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_PARAMETERS)
    public abstract ImmutableSet parameters();

    @JsonView(ContentPackView.HttpView.class)
    @JsonProperty(FIELD_ENTITIES)
    public abstract ImmutableSet entities();

    public ContentPackV1 toContentPackV1() {
        return ContentPackV1.builder()
                .id(id())
                .revision(revision())
                .name(name())
                .summary(summary())
                .description(description())
                .vendor(vendor())
                .url(url())
                .parameters(parameters())
                .entities(entities())
                .build();
    }

    static Builder builder() {
        return Builder.builder();
    }

    @AutoValue.Builder
    abstract static class Builder implements ContentPack.ContentPackBuilder {
        private Collection inputs = Collections.emptySet();
        private Collection streams = Collections.emptySet();
        private Collection outputs = Collections.emptySet();
        private Collection grokPatterns = Collections.emptySet();
        private Collection lookupTables = Collections.emptySet();
        private Collection lookupCaches = Collections.emptySet();
        private Collection lookupDataAdapters = Collections.emptySet();

        @JsonCreator
        static Builder builder() {
            return new AutoValue_LegacyContentPack.Builder()
                    // Set default id which can be overwritten by Jackson via `Builder#id(ModelId)`
                    .id(ModelId.of(UUID.randomUUID().toString()));
        }

        @JsonProperty(FIELD_DB_ID)
        abstract Builder _id(ObjectId _id);

        @JsonProperty(FIELD_NAME)
        abstract Builder name(String name);

        @JsonProperty(FIELD_SUMMARY)
        abstract Builder summary(String summary);

        @JsonProperty(FIELD_DESCRIPTION)
        abstract Builder description(String description);

        @JsonProperty(FIELD_VENDOR)
        abstract Builder vendor(String vendor);

        @JsonProperty(FIELD_URL)
        abstract Builder url(URI url);

        @JsonProperty(FIELD_REQUIRES)
        abstract Builder requires(ImmutableSet requirements);

        @JsonProperty(FIELD_PARAMETERS)
        abstract Builder parameters(ImmutableSet parameters);

        @JsonProperty(FIELD_ENTITIES)
        abstract Builder entities(ImmutableSet entities);

        @JsonProperty("category")
        Builder category(@SuppressWarnings("unused") String category) {
            // Ignored
            return this;
        }

        @JsonProperty("inputs")
        Builder inputs(Collection inputs) {
            this.inputs = convertInputs(inputs);
            return this;
        }

        @JsonProperty("streams")
        Builder streams(Collection streams) {
            this.streams = convertStreams(streams);
            return this;
        }

        @JsonProperty("outputs")
        Builder outputs(Collection outputs) {
            this.outputs = convertOutputs(outputs);
            return this;
        }

        @JsonProperty("dashboards")
        Builder dashboards(Collection dashboards) {
            // Todo: implement support for new Dashboards
            return this;
        }

        @JsonProperty("grok_patterns")
        Builder grokPatterns(Collection grokPatterns) {
            this.grokPatterns = convertGrokPatterns(grokPatterns);
            return this;
        }

        @JsonProperty("lookup_tables")
        Builder lookupTables(Collection lookupTables) {
            this.lookupTables = convertLookupTables(lookupTables);
            return this;
        }

        @JsonProperty("lookup_caches")
        Builder lookupCaches(Collection lookupCaches) {
            this.lookupCaches = convertLookupCaches(lookupCaches);
            return this;
        }

        @JsonProperty("lookup_data_adapters")
        Builder lookupDataAdapters(Collection lookupDataAdapters) {
            this.lookupDataAdapters = convertLookupDataAdapters(lookupDataAdapters);
            return this;
        }

        abstract LegacyContentPack autoBuild();

        public LegacyContentPack build() {
            // TODO: Resolve references between entities such as streams and dashboards.
            final ImmutableSet entities = ImmutableSet.builder()
                    .addAll(inputs)
                    .addAll(streams)
                    .addAll(outputs)
                    .addAll(grokPatterns)
                    .addAll(lookupTables)
                    .addAll(lookupCaches)
                    .addAll(lookupDataAdapters)
                    .build();

            version(VERSION);
            revision(DEFAULT_REVISION);
            summary("[auto-generated]");
            vendor("[auto-generated]");
            url(URI.create("https://www.graylog.org/"));
            requires(ImmutableSet.of());
            parameters(ImmutableSet.of());
            entities(entities);

            return autoBuild();
        }

        private Collection convertInputs(Collection inputs) {
            if (inputs == null || inputs.isEmpty()) {
                return Collections.emptySet();
            }

            return inputs.stream()
                    .map(this::convertInput)
                    .collect(Collectors.toSet());
        }

        private Entity convertInput(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("id").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.INPUT_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertStreams(Collection streams) {
            if (streams == null || streams.isEmpty()) {
                return Collections.emptySet();
            }

            return streams.stream()
                    .map(this::convertStream)
                    .collect(Collectors.toSet());
        }

        private Entity convertStream(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("id").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.STREAM_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertOutputs(Collection outputs) {
            if (outputs == null || outputs.isEmpty()) {
                return Collections.emptySet();
            }

            return outputs.stream()
                    .map(this::convertOutput)
                    .collect(Collectors.toSet());
        }

        private Entity convertOutput(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("id").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.OUTPUT_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertGrokPatterns(Collection grokPatterns) {
            if (grokPatterns == null || grokPatterns.isEmpty()) {
                return Collections.emptySet();
            }

            return grokPatterns.stream()
                    .map(this::convertGrokPattern)
                    .collect(Collectors.toSet());
        }

        private Entity convertGrokPattern(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("name").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.GROK_PATTERN_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertLookupTables(Collection lookupTables) {
            if (lookupTables == null || lookupTables.isEmpty()) {
                return Collections.emptySet();
            }

            return lookupTables.stream()
                    .map(this::convertLookupTable)
                    .collect(Collectors.toSet());
        }

        private Entity convertLookupTable(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("name").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.LOOKUP_TABLE_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertLookupCaches(Collection lookupCaches) {
            if (lookupCaches == null || lookupCaches.isEmpty()) {
                return Collections.emptySet();
            }

            return lookupCaches.stream()
                    .map(this::convertLookupCache)
                    .collect(Collectors.toSet());
        }

        private Entity convertLookupCache(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("name").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.LOOKUP_CACHE_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }

        private Collection convertLookupDataAdapters(Collection lookupDataAdapters) {
            if (lookupDataAdapters == null || lookupDataAdapters.isEmpty()) {
                return Collections.emptySet();
            }

            return lookupDataAdapters.stream()
                    .map(this::convertLookupDataAdapter)
                    .collect(Collectors.toSet());
        }

        private Entity convertLookupDataAdapter(JsonNode json) {
            return EntityV1.builder()
                    .id(ModelId.of(json.path("name").asText(UUID.randomUUID().toString())))
                    .type(ModelTypes.LOOKUP_ADAPTER_V1)
                    .version(ModelVersion.of("1"))
                    .data(json)
                    .build();
        }
    }
}